From fdd6b6adee4b5feddf90dc0aa1b3ad582a9dc619 Mon Sep 17 00:00:00 2001 From: maehw Date: Sat, 23 Oct 2021 21:53:49 +0200 Subject: [PATCH] Change README section with dependencies --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1a0c4ba..c506561 100644 --- a/README.md +++ b/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 ``` -### python based - sphinx +### Python based dependencies 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``` 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/). -For pdf output the latex builder is used, so it needs also an installed latex and pdflatex. +### Other dependencies + +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 The top level directory contains a Makefile, -for generation with all output formats use +for generation with all output formats use ````` make bundle