diff --git a/README.md b/README.md index 8f334e0..3a61aff 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ this projects is an experiment of how to generate html, epub and pdf from the git repository for the WTF Handbook. -The handbuch sources are inclued as git submodule. +The handbuch sources are included as git submodule. It contains a configuration for three different generators: @@ -20,8 +20,49 @@ tbd more details on README.md in sphinx directory ## How to build -tbd +### rust based tools mdbook and crowbook +For building you need a rust installation. +This can be achieved by using the installer from https://rustup.rs + +After installing the rust toolchain for your platform you have to install the needed tools: +```` +cargo install mdbook +cargo install mdbook-epub +cargo install crowbook +```` + +Crowbook needs xelatex for building the pdf outputs. + +### python based - sphinx + +First create a Python 3 virtual environment using the venv module included with Python 3. + +```` + python -m venv py3-sphinx +````` + +Now “activate” the environment. Look for the name of the virtual environment enclosed in parenthesis after activation. + +````` + source py3-sphinx/bin/activate +`````` + +Expected Output +````` + (py3-sphinx) $ +`````` + +In the virtual environment install the following modules with pip: + +````` + (py3-sphinx) $ pip install sphinx3 sphinxcontrib-plantuml myst_parser +`````` + +For generating the images from plantuml-sources it needs also [Plantuml](https://plantuml.com/). +For pdf output the latex builder is used, so it needs also an installed latex and pdflatex. + +## ## Issues ### mdbook - rendering problem with current inputs