From 4ae1589657573946c7610d5e57d95994ccbe83c1 Mon Sep 17 00:00:00 2001 From: simonsan <14062932+simonsan@users.noreply.github.com> Date: Sun, 17 Mar 2024 04:17:15 +0100 Subject: [PATCH] chore: update build instructions to account for new dependencies --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 6954c59..fbdfacd 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,29 @@ information on how contributing to this repository works. This book is built with [mdbook](https://rust-lang.github.io/mdBook/). You can install it by running `cargo install mdbook`. +### Additional dependencies + +- `cargo install mdbook-last-changed` for date changes in the footer + +- `cargo install mdbook-pandoc` for rendering the book to PDF + +- `cargo install mdbook-i18n-helpers` for translation and i8n support + +#### Texlive + +```sh +# Source the .env file to get the PANDOC_VERSION +. ./.env + +sudo apt-get update + +sudo apt-get install -y texlive texlive-latex-extra texlive-luatex texlive-lang-cjk librsvg2-bin fonts-noto + +curl -LsSf https://github.com/jgm/pandoc/releases/download/$PANDOC_VERSION/pandoc-$PANDOC_VERSION-linux-amd64.tar.gz | tar zxf - +``` + +### Building the book + If you want to build it locally you can run one of these two commands in the root directory of the repository: