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

Readme #15

Merged
Brain merged 6 commits from dancingCycle/handbuch-gen:readme into main 2022-11-22 21:10:22 +01:00
Conversation 1 Commits 6 Files Changed 1 +9 -1
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 2265935bd6 - Show all commits

10
README.md
View File

@ -37,7 +37,15 @@ In order to generate the documentation, first create a Python 3 virtual environm
For generating the images from PlantUML sources (`*.plantuml`), [PlantUML](https://plantuml.com/) is required. 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. For pdf output the LaTeX builder is used, so `latex` and `pdflatex` need to be installed. On a clean (no Latex compilation yet) operating system like GNU/Debian, the following dependencies are required to make Latex compile the sources.
```
sudo apt install texlive-base --no-install-recommends
sudo apt-get install texlive-latex-base --no-install-recommends
sudo apt-get install texlive-latex-extra --no-install-recommends
sudo apt-get install texlive-lang-german --no-install-recommends
sudo apt-get install texlive-fonts-extra --no-install-recommends
Brain commented 2022-11-22 13:18:35 +01:00
Outdated
Review
Copy Link

Could be summarized into one apt-get command. If readability is a concern, linebreaks can be applied like this:

sudo apt-get --no-install-recommends install \
  texlive-base \
  texlive-latex-base \
  ...
Could be summarized into one `apt-get` command. If readability is a concern, linebreaks can be applied like this: ```bash sudo apt-get --no-install-recommends install \ texlive-base \ texlive-latex-base \ ... ```
```
For document generation `make` and latexmk` is required. For document generation `make` and latexmk` is required.
Brain commented 2022-11-22 13:11:04 +01:00
Outdated
Review
Copy Link

latexmk is missing a ` at the beginning

latexmk is missing a ` at the beginning