magnus167/rustframe
1
0
Fork 0
mirror of https://github.com/Magnus167/rustframe.git synced 2025-08-19 23:09:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add instructions for building the user guide

Browse Source
This commit is contained in:
Palash Tyagi 2025-08-03 23:25:13 +01:00
parent c7552f2264
commit ae27ed9373
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -198,3 +198,13 @@ To run the benchmarks, use:
```bash ```bash
cargo bench --features "bench" cargo bench --features "bench"
``` ```
## Building the user-guide
To build the user guide, use:
```bash
cargo binstall mdbook
bash docs/build.sh
```
This will generate the user guide in the `docs/book` directory.