feat: call git submodule add git@github.com:dancesWithCycles/manual.git source/manual/

This commit is contained in:
dancingCycle 2022-10-21 14:11:45 +02:00
parent d5810bfe99
commit 59a28e78ab
3 changed files with 26 additions and 1 deletions

3
.gitmodules vendored Normal file
View File

@ -0,0 +1,3 @@
[submodule "source/manual"]
path = source/manual
url = git@github.com:dancesWithCycles/manual.git

View File

@ -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 <git remote repository>
```
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.

1
source/manual Submodule

@ -0,0 +1 @@
Subproject commit 7ebc7cddc760fced4ac44001067d6471a73c823a