forked from sinara-hw/assembly
Avoid over-relience on nix build for building docs
Signed-off-by: Egor Savkin <es@m-labs.hk>
This commit is contained in:
parent
49de48aa32
commit
ea1b0b5c56
16
README.md
16
README.md
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Repository with instructions and remarks on assembling and testing Sinara hardware
|
Repository with instructions and remarks on assembling and testing Sinara hardware
|
||||||
|
|
||||||
### Build docs
|
## Build docs
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
nix build
|
nix build
|
||||||
|
@ -17,7 +17,19 @@ nix develop
|
||||||
mdbook build
|
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
|
## Contributing
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue