demos: add demos/README.md

jj-vcs · Sep 10, 2023 · 3c4e197 · 3c4e197
1 parent c3b5590
commit 3c4e197
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/demos/README.md b/demos/README.md
@@ -0,0 +1,18 @@
+The `demo_*.sh` scripts in this directory demo
+various features of `jj`.
+
+The `run_scripts.sh` script can be used to:
+
+- Run them inside a standardized environment instead of the user's local environment.
+- Generate SVG and PNG images for the scripts.
+
+This requires ImageMagick and `term-transcript-cli` to be
+installed. See `run_scripts.sh`'s error messages for some
+more details.
+
+One way to make all the images and check the output is:
+
+```shell
+$ cd demos
+$  ./run_scripts.sh demo_*.sh |less
+```