summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick Gerace <nickagerace@gmail.com>2023-02-05 14:00:24 -0500
committerNick Gerace <nickagerace@gmail.com>2023-02-05 20:53:40 -0500
commitad9c3b3841a0da9d142f979b1d91591fd66e180d (patch)
tree125fc13f49649c850c773d3ac5f00b18e4005558 /docs
parent80fb983cfe8e1704361ac9ad8f9c4d1948c63ac6 (diff)
downloadgfold-ad9c3b3841a0da9d142f979b1d91591fd66e180d.zip
Add demo gif
Signed-off-by: Nick Gerace <nickagerace@gmail.com>
Diffstat (limited to 'docs')
-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>
+```