Skip to content

Commit 358aab8

Browse files
authored
docs: document how to maintain the Asciinema demo (#306)
1 parent f6ce8d6 commit 358aab8

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/asciinema/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# 🎞️ Asciinema
2+
3+
For full documentation, visit [docs.asciinema.org](https://docs.asciinema.org/).
4+
5+
## ⚙️ Prerequisites
6+
7+
Make sure the following tools are installed:
8+
9+
- 📼 [asciinema CLI](https://asciinema.org/docs/installation) – used to record terminal sessions
10+
- 🖼️ [agg CLI](https://docs.asciinema.org/manual/agg/installation/) – used to convert recordings into GIFs
11+
12+
## 📝 Format
13+
14+
Recordings use the [Asciicast v2 format](https://docs.asciinema.org/manual/asciicast/v2/).
15+
16+
## Publishing Recording
17+
18+
The recording must be published under [this profile](https://asciinema.org/~Djaytan).
19+
20+
This can be done by running the following commands:
21+
22+
```bash
23+
$ asciinema auth
24+
```
25+
26+
## 🧰 Generating a GIF
27+
28+
To generate a GIF from a recording, refer to the [official guide](https://docs.asciinema.org/getting-started/#generating-a-gif).
29+
30+
In short, run:
31+
32+
```bash
33+
agg demo-gif.cast demo.gif
34+
```

0 commit comments

Comments
 (0)