feat: add to README the instruction: git submodule update --remote --merge
This commit is contained in:
parent
c631d90a3d
commit
466f44f94a
12
README.md
12
README.md
|
@ -12,7 +12,8 @@ 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.
|
||||
you can always update the content of submodules with the git
|
||||
`submodule update` command.
|
||||
Execute the command from the main project directory:
|
||||
|
||||
```
|
||||
|
@ -22,6 +23,15 @@ 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.
|
||||
|
||||
If new commits are available for submodules,
|
||||
you can always update the **remote** content of submudlues with the git
|
||||
`submodule update` command.
|
||||
Execute the command from the main project directory:
|
||||
|
||||
```
|
||||
git submodule update --remote --merge
|
||||
```
|
||||
|
||||
## Python Dependencies
|
||||
In order to generate the documentation,
|
||||
first create a Python 3 virtual environment using the
|
||||
|
|
Loading…
Reference in New Issue