dancingCycle
/
handbuch-gen
forked from wtf-eg/handbuch-gen
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

#15 doc: adjust section: checkout with submodules

This commit is contained in:
dancingCycle 2022-10-14 08:28:08 +02:00
parent 0474d264b5
commit 8d6ee6f776
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -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: