dan/cushy
1
0
Fork 0
mirror of https://github.com/danbulant/cushy synced 2026-05-19 04:08:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
cushy/guide
History
Daniel Bulant e3898bda50
Add a simple example about reading and synchronizing values from a Scroll
2024-10-16 22:41:42 +02:00
..
guide-examples Bumping version 2024-08-20 12:30:41 -07:00
src Add a simple example about reading and synchronizing values from a Scroll 2024-10-16 22:41:42 +02:00
theme Moved guide "warning" to all pages 2024-01-09 06:53:18 -08:00
.gitignore Guide readme + cleaning repo 2024-05-12 07:20:52 -07:00
book.toml Children renamed to WidgetList 2024-01-09 13:26:14 -08:00
README.md Guide readme + cleaning repo 2024-05-12 07:20:52 -07:00

README.md

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:

    CAPTURE=1 cargo test -p guide-examples --examples

  3. Build the guide:

    mdbook build guide