From ea1b0b5c56f3a9cbb1aa41c3e994d4054ee05611 Mon Sep 17 00:00:00 2001 From: Egor Savkin Date: Tue, 18 Jun 2024 15:31:09 +0800 Subject: [PATCH] Avoid over-relience on nix build for building docs Signed-off-by: Egor Savkin --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b5dbdde..f6a1ea6 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Repository with instructions and remarks on assembling and testing Sinara hardware -### Build docs +## Build docs ```shell nix build @@ -17,7 +17,19 @@ nix develop mdbook build ``` -The output files are in `book` directory. +The output files will be in `book` directory. + +### Alternative way + +Since the docs builder depends only on mdBook, you may get it from anywhere you like - `nix-shell -p mdbook`, +`snap install mdbook`, `cargo install mdbook` or any other from your OS. +After that you will be able to do: + +```shell +mdbook build +``` + +The output files will be in `book` directory. ## Contributing