linuswck/sinara-hw-assembly
1
0
Fork 0
forked from sinara-hw/assembly
Code Pull Requests Activity

Avoid over-relience on nix build for building docs

Browse Source 
Signed-off-by: Egor Savkin <es@m-labs.hk>
This commit is contained in:
Egor Savkin 2024-06-18 15:31:09 +08:00
parent 49de48aa32
commit ea1b0b5c56
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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