From 9fb2e17b21916e3ac714d5babdb0e30cb2448dcb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ng=C3=B4=20Ng=E1=BB=8Dc=20=C4=90=E1=BB=A9c=20Huy?= Date: Tue, 20 Apr 2021 21:46:58 +0700 Subject: [PATCH] Add build instruction --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index d7b030c..88814e6 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,24 @@ These documentations are licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License][CC-BY-SA]. [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.