diff --git a/guide/.gitignore b/guide/.gitignore index 7585238..5ae24e0 100644 --- a/guide/.gitignore +++ b/guide/.gitignore @@ -1 +1,2 @@ book +src/examples/*.png \ No newline at end of file diff --git a/guide/README.md b/guide/README.md new file mode 100644 index 0000000..6117184 --- /dev/null +++ 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 new file mode 100644 index 0000000..e69de29 diff --git a/guide/src/examples/align.png b/guide/src/examples/align.png deleted file mode 100644 index 9a35005..0000000 Binary files a/guide/src/examples/align.png and /dev/null differ diff --git a/guide/src/examples/composition_makewidget.png b/guide/src/examples/composition_makewidget.png deleted file mode 100644 index d053791..0000000 Binary files a/guide/src/examples/composition_makewidget.png and /dev/null differ diff --git a/guide/src/examples/composition_widget.png b/guide/src/examples/composition_widget.png deleted file mode 100644 index da4c9e2..0000000 Binary files a/guide/src/examples/composition_widget.png and /dev/null differ diff --git a/guide/src/examples/composition_wrapperwidget.png b/guide/src/examples/composition_wrapperwidget.png deleted file mode 100644 index da4c9e2..0000000 Binary files a/guide/src/examples/composition_wrapperwidget.png and /dev/null differ diff --git a/guide/src/examples/hello_world.png b/guide/src/examples/hello_world.png deleted file mode 100644 index 76c2c79..0000000 Binary files a/guide/src/examples/hello_world.png and /dev/null differ diff --git a/guide/src/examples/intro.png b/guide/src/examples/intro.png deleted file mode 100644 index 4733a26..0000000 Binary files a/guide/src/examples/intro.png and /dev/null differ diff --git a/guide/src/examples/thread_progress.png b/guide/src/examples/thread_progress.png deleted file mode 100644 index fcb4c34..0000000 Binary files a/guide/src/examples/thread_progress.png and /dev/null differ