From 8d6ee6f776b846f07ff8a1ba8ad3dfcda643fbfc Mon Sep 17 00:00:00 2001 From: "Begerad, Stefan" Date: Fri, 14 Oct 2022 08:28:08 +0200 Subject: [PATCH 1/6] #15 doc: adjust section: checkout with submodules --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 93dc8de..0465879 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,14 @@ 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 ``` +If you cloned this repository initially without submobules, you can always update the content of submodule directories with the git submodule update command. Execute the command from the main project directory: + +``` +git submodule update --init --recursive +``` + +The --init flag initializes the submodules before the update. The --recursive option searches for nested submodules and ensures they are updated too. + ### Python based dependencies In order to generate the documentation, first create a Python 3 virtual environment using the `venv` module included in Python 3: From 3414b67e58a739c3c541bb830c7cad0008076310 Mon Sep 17 00:00:00 2001 From: "Begerad, Stefan" Date: Fri, 14 Oct 2022 09:22:23 +0200 Subject: [PATCH 2/6] #15 doc: adjust section: other dependencies --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 0465879..72ab4b8 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,8 @@ For generating the images from PlantUML sources (`*.plantuml`), [PlantUML](https For pdf output the LaTeX builder is used, so `latex` and `pdflatex` need to be installed. +For document generation `make` and latexmk` is required. + ### Running the document generation via make The top level directory contains a Makefile, for generation with all output formats use From 2265935bd654c977b95db3dbc5af9796454e0659 Mon Sep 17 00:00:00 2001 From: "Begerad, Stefan" Date: Fri, 14 Oct 2022 09:55:46 +0200 Subject: [PATCH 3/6] #15 doc: adjust section: other dependencies --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 72ab4b8..c095e2f 100644 --- a/README.md +++ b/README.md @@ -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 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 +``` For document generation `make` and latexmk` is required. From b8b9be989110fd79da7024a94b5f7d1dc1690929 Mon Sep 17 00:00:00 2001 From: "Begerad, Stefan" Date: Fri, 14 Oct 2022 10:11:33 +0200 Subject: [PATCH 4/6] #15 doc: add section: clean up --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index c095e2f..4cebfb9 100644 --- a/README.md +++ b/README.md @@ -60,3 +60,8 @@ make bundle The output files of the final handbook can be found in the subfolder `./bundle`. All generated intermediate artifacts and the final output files can be found in the `./build` subfolder. + +### Clean up + +1. Deactivate the virtual Python environment: ```deactivate``` +2. Clean up the build sources: ```make clean``` and ```rm -r build bundle``` From f03e5d87ebf8edb3f896d3216ed9b6a2dde8f0dd Mon Sep 17 00:00:00 2001 From: "Begerad, Stefan" Date: Tue, 22 Nov 2022 15:20:28 +0100 Subject: [PATCH 5/6] #15 doc: summarized apt install --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 4cebfb9..d5b19c5 100644 --- a/README.md +++ b/README.md @@ -40,11 +40,7 @@ For generating the images from PlantUML sources (`*.plantuml`), [PlantUML](https 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 +sudo apt install texlive-base texlive-latex-base texlive-latex-extra texlive-lang-german texlive-fonts-extra --no-install-recommends ``` For document generation `make` and latexmk` is required. From b67f892ed59941a4a4841880a2bb737278e84ffd Mon Sep 17 00:00:00 2001 From: "Begerad, Stefan" Date: Tue, 22 Nov 2022 15:21:53 +0100 Subject: [PATCH 6/6] #15 doc: add missing markdown --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d5b19c5..6f53212 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ For pdf output the LaTeX builder is used, so `latex` and `pdflatex` need to be i sudo apt install texlive-base texlive-latex-base texlive-latex-extra texlive-lang-german texlive-fonts-extra --no-install-recommends ``` -For document generation `make` and latexmk` is required. +For document generation `make` and `latexmk` is required. ### Running the document generation via make