Guide readme + cleaning repo

khonsulabs · May 12, 2024 · be7145a · be7145a
1 parent ad19981
commit be7145a
Show file tree

Hide file tree

Showing 10 changed files with 18 additions and 0 deletions.
diff --git a/guide/.gitignore b/guide/.gitignore
@@ -1 +1,2 @@
 book
+src/examples/*.png
diff --git a/guide/README.md b/guide/README.md
@@ -0,0 +1,17 @@
+# Cushy User Guide
+
+The Cushy user guide contains examples that are generated using Cushy's virtual
+recorder functionality. To build this guide:
+
+1. Install mdbook and mdbook-variables
+2. Capture examples:
+
+   ```sh
+   CAPTURE=1 cargo test -p guide-examples --examples
+   ```
+
+3. Build the guide:
+
+   ```sh
+   mdbook build guide
+   ```
diff --git a/guide/src/examples/.gitkeep b/guide/src/examples/.gitkeep
diff --git a/guide/src/examples/align.png b/guide/src/examples/align.png
diff --git a/guide/src/examples/composition_makewidget.png b/guide/src/examples/composition_makewidget.png
diff --git a/guide/src/examples/composition_widget.png b/guide/src/examples/composition_widget.png
diff --git a/guide/src/examples/composition_wrapperwidget.png b/guide/src/examples/composition_wrapperwidget.png
diff --git a/guide/src/examples/hello_world.png b/guide/src/examples/hello_world.png
diff --git a/guide/src/examples/intro.png b/guide/src/examples/intro.png
diff --git a/guide/src/examples/thread_progress.png b/guide/src/examples/thread_progress.png