Guide readme + cleaning repo
1
guide/.gitignore
vendored
|
|
@ -1 +1,2 @@
|
|||
book
|
||||
src/examples/*.png
|
||||
17
guide/README.md
Normal 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
|
||||
```
|
||||
0
guide/src/examples/.gitkeep
Normal file
|
Before Width: | Height: | Size: 39 KiB |
|
Before Width: | Height: | Size: 8.9 KiB |
|
Before Width: | Height: | Size: 8.9 KiB |
|
Before Width: | Height: | Size: 8.9 KiB |
|
Before Width: | Height: | Size: 6.9 KiB |
|
Before Width: | Height: | Size: 88 KiB |
|
Before Width: | Height: | Size: 24 KiB |