Add build instruction
This commit is contained in:
parent
2dcad731a6
commit
9fb2e17b21
21
README.md
21
README.md
|
@ -12,3 +12,24 @@ These documentations are licensed under a
|
||||||
[Creative Commons Attribution-ShareAlike 4.0 International License][CC-BY-SA].
|
[Creative Commons Attribution-ShareAlike 4.0 International License][CC-BY-SA].
|
||||||
|
|
||||||
[CC-BY-SA]: https://creativecommons.org/licenses/by-sa/2.0/
|
[CC-BY-SA]: https://creativecommons.org/licenses/by-sa/2.0/
|
||||||
|
|
||||||
|
## Builds
|
||||||
|
|
||||||
|
To build the book, you would need to install Rust and all the things coming with it.
|
||||||
|
|
||||||
|
1. Install `mdBook` crate
|
||||||
|
|
||||||
|
```
|
||||||
|
cargo install mdbook
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Build it
|
||||||
|
|
||||||
|
```
|
||||||
|
mdbook build
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Find the book in `book/`
|
||||||
|
|
||||||
|
Alternatively, you can use `mdbook-latex` for generating LaTeX/PDF, but for now
|
||||||
|
it has a broken dependency.
|
||||||
|
|
Loading…
Reference in New Issue