wtf-eg/handbuch-gen
Archived
1
0
Fork 2
forked from gulliver/rtfm
Code Issues Pull Requests Projects Releases Wiki Activity

Anpassungen an README.md #5

Closed
maehw wants to merge 8 commits from maehw:maehw-review into main
pull from: maehw:maehw-review
merge into: wtf-eg:main
Conversation 2 Commits 8 Files Changed 1 +7 -6
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 427fc4577d - Show all commits

11
README.md
View File

@ -20,17 +20,18 @@ 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