Guide readme + cleaning repo

This commit is contained in:
Jonathan Johnson 2024-05-12 07:20:52 -07:00
parent ad19981704
commit be7145a43f
No known key found for this signature in database
GPG key ID: A66D6A34D6620579
10 changed files with 18 additions and 0 deletions

1
guide/.gitignore vendored
View file

@ -1 +1,2 @@
book
src/examples/*.png

17
guide/README.md Normal file
View file

@ -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
```

View file

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB