about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorNgô Ngọc Đức Huy <huyngo@disroot.org>2021-04-20 21:46:58 +0700
committerNgô Ngọc Đức Huy <huyngo@disroot.org>2021-04-20 21:46:58 +0700
commit9fb2e17b21916e3ac714d5babdb0e30cb2448dcb (patch)
tree0cdeb20a5b707c34ac9ca66a67d037804f3eff9e /README.md
parent2dcad731a66641dd422a217f5b244dd06a3406fe (diff)
downloadhaasdaiga-9fb2e17b21916e3ac714d5babdb0e30cb2448dcb.tar.gz
Add build instruction
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
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.