diff options
| author | Vincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com> | 2020-02-19 08:29:27 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-19 08:29:27 +0100 |
| commit | 9b4258e4f5abb355670afb69d60f3002cb9c27b0 (patch) | |
| tree | 84d10fe4d5a78eb4147a0dcd7b386474be07aa9e /.github/how_to_use_github_to_contribute_to_gudhi.md | |
| parent | 8dc47a277c50744812a6e65e8e817fed479b301d (diff) | |
Doc review: submodule rephrase [skip ci]
Diffstat (limited to '.github/how_to_use_github_to_contribute_to_gudhi.md')
| -rw-r--r-- | .github/how_to_use_github_to_contribute_to_gudhi.md | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/.github/how_to_use_github_to_contribute_to_gudhi.md b/.github/how_to_use_github_to_contribute_to_gudhi.md index 0e7d42ef..0a6133b7 100644 --- a/.github/how_to_use_github_to_contribute_to_gudhi.md +++ b/.github/how_to_use_github_to_contribute_to_gudhi.md @@ -25,9 +25,10 @@ This creates a directory gudhi-devel, which you are free to move around or renam cd gudhi-devel ``` -## Submodule -An interface to Hera for Wasserstein distance is available on an external git repository. -Everytime you checkout master or merge from master, afterwards, you will need to run the command: +Everytime you clone the repository, you will have to download the *submodules*. + +## Submodules +An interface to Hera for Wasserstein distance is available on an external git repository. To download it: ```bash git submodule update --init ``` @@ -59,6 +60,11 @@ This is a command you can run quite regularly. It tells git to check all that happened on github. It is safe, it will not mess with your files. +**Reminder:** Everytime you checkout master or merge from master, afterwards, if the version of one the submodule has changed, or if a submodule was added, you will have to: +```bash +git submodule update --init +``` + ## Create a branch, based on the current master ```bash git checkout -b some-fancy-name --no-track upstream/master |