From ae27ed93737af941d879b3d100eac2b2991c1276 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Sun, 3 Aug 2025 23:25:13 +0100 Subject: [PATCH] Add instructions for building the user guide --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index fd6123c..5b0f859 100644 --- a/README.md +++ b/README.md @@ -198,3 +198,13 @@ To run the benchmarks, use: ```bash 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.