forked from wtf-eg/handbuch-gen
Change README section with dependencies
This commit is contained in:
parent
3aec12d210
commit
fdd6b6adee
13
README.md
13
README.md
@ -22,22 +22,23 @@ This repository accesses the required WTF handbook's content as a git submodule.
|
|||||||
git clone --recurse-submodules https://git.wtf-eg.de/wtf-eg/handbuch-gen.git
|
git clone --recurse-submodules https://git.wtf-eg.de/wtf-eg/handbuch-gen.git
|
||||||
```
|
```
|
||||||
|
|
||||||
### python based - sphinx
|
### Python based dependencies
|
||||||
|
|
||||||
First create a Python 3 virtual environment using the venv module included with Python 3.
|
First create a Python 3 virtual environment using the venv module included with Python 3.
|
||||||
|
|
||||||
|
|
||||||
1. Create a virtual Python environment in the directory `venv` using the Python module `venv`: ```python3 -m venv venv```
|
1. Create a virtual Python environment in the directory `venv` using the Python module `venv`: ```python3 -m venv venv```
|
||||||
2. Activate the virtual Python environment: ```source venv/bin/activate```
|
2. Activate the virtual Python environment: ```source venv/bin/activate```
|
||||||
3. Install needed packages from ```requirements.txt```: ```pip install -r requirements.txt```
|
3. Install the packages listed in [./requirements.txt](requirements.txt) using `pip`: ```pip install -r requirements.txt```
|
||||||
|
|
||||||
For generating the images from plantuml-sources it needs also [Plantuml](https://plantuml.com/).
|
### Other dependencies
|
||||||
For pdf output the latex builder is used, so it needs also an installed latex and pdflatex.
|
|
||||||
|
For generating the images from PlantUML sources (`*.plantuml`), [Plantuml](https://plantuml.com/) is required.
|
||||||
|
For pdf output the latex builder is used, so latex and pdflatex need to be installed.
|
||||||
|
|
||||||
### Running the document generation via make
|
### Running the document generation via make
|
||||||
|
|
||||||
The top level directory contains a Makefile,
|
The top level directory contains a Makefile,
|
||||||
for generation with all output formats use
|
for generation with all output formats use
|
||||||
|
|
||||||
`````
|
`````
|
||||||
make bundle
|
make bundle
|
||||||
|
Loading…
Reference in New Issue
Block a user