Skip to content

Commit

Permalink
docs: new gif
Browse files Browse the repository at this point in the history
  • Loading branch information
maaslalani committed May 27, 2024
1 parent f0996f6 commit 8bcbc80
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 32 deletions.
52 changes: 20 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,72 +7,60 @@ Slides in your terminal.
</p>

### Installation
[![Homebrew](https://img.shields.io/badge/dynamic/json.svg?url=https://formulae.brew.sh/api/formula/slides.json&query=$.versions.stable&label=homebrew)](https://formulae.brew.sh/formula/slides)
[![Snapcraft](https://snapcraft.io/slides/badge.svg)](https://snapcraft.io/slides)
[![AUR](https://img.shields.io/aur/version/slides?label=AUR)](https://aur.archlinux.org/packages/slides)

<details markdown="block">
<summary>Instructions</summary>
Use a package manager:

#### MacOS
```
```sh
# macOS or Linux
brew install slides
```
#### Arch
```
yay -S slides
```
#### Nixpkgs (unstable)
```

# Arch Linux (btw)
pacman -S slides

# Nix
nix-env -iA nixpkgs.slides
```
#### Any Linux Distro running `snapd`
```
sudo snap install slides
```
#### Go
```

Or, just install it with `go`:

```sh
go install github.com/maaslalani/slides@latest
```
From source:
```
git clone https://github.com/maaslalani/slides.git
cd slides
go install
```

You can also download a binary from the [releases](https://github.com/maaslalani/slides/releases) page.

</details>
### Usage

Create a markdown file:

### Usage
Create a simple markdown file that contains your slides:
````md

````markdown
# Welcome to Slides

A terminal based presentation tool

---

## Everything is markdown

In fact, this entire presentation is a markdown file.

---

## Everything happens in your terminal

Create slides and present them without ever leaving your terminal.

---

## Code execution

```go
package main

import "fmt"

func main() {
fmt.Println("Execute code directly inside the slides")
fmt.Println("Tada!")
}
```

Expand Down
Binary file modified assets/slides.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8bcbc80

Please sign in to comment.