summaryrefslogtreecommitdiff
path: root/docs/DEMO.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/DEMO.md')
-rw-r--r--docs/DEMO.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/DEMO.md b/docs/DEMO.md
new file mode 100644
index 0000000..7d7b751
--- /dev/null
+++ b/docs/DEMO.md
@@ -0,0 +1,15 @@
+# Demo
+
+This document contains information related to the [demo GIF](../assets/demo.gif).
+
+## Attribution
+
+The demo was recorded with [asciinema](https://asciinema.org/) and was converted to a GIF using [`agg`](https://github.com/asciinema/agg).
+
+## Converting Recordings Into GIFs
+
+Using `agg`, convert the recording into a GIF.
+
+```shell
+agg --theme monokai --rows 32 --font-size 15 --idle-time-limit 2 <INPUT> <OUTPUT>
+```