mirror of
https://github.com/danbulant/cushy
synced 2026-06-13 19:42:39 +00:00
17 lines
336 B
Markdown
17 lines
336 B
Markdown
# 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
|
|
```
|