diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..3222e5e --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "source/manual"] + path = source/manual + url = git@github.com:dancesWithCycles/manual.git diff --git a/README.md b/README.md index 5917416..e074870 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ # manual-gen -generate manual +Generate the manual. + +# Build + +## Checkout +This repository accesses the required `manual` repository as a git submodule. +Therefore, make sure to check out this repository and included submodules: + +``` +git clone --recurse-submodules +``` + +If you cloned this repository initially without submobules, +you can always update the content of submodules 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. diff --git a/source/manual b/source/manual new file mode 160000 index 0000000..7ebc7cd --- /dev/null +++ b/source/manual @@ -0,0 +1 @@ +Subproject commit 7ebc7cddc760fced4ac44001067d6471a73c823a