From 8d6ee6f776b846f07ff8a1ba8ad3dfcda643fbfc Mon Sep 17 00:00:00 2001 From: "Begerad, Stefan" Date: Fri, 14 Oct 2022 08:28:08 +0200 Subject: [PATCH] #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: