summaryrefslogtreecommitdiff
path: root/.github/how_to_use_github_to_contribute_to_gudhi.md
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-03-13 09:17:25 +0100
committerMarc Glisse <marc.glisse@inria.fr>2020-03-13 09:17:25 +0100
commitba24c58487f9a62e024138127c1b8375449334f9 (patch)
treeef2e1191cf94c876abf74d2b5a430980098114d5 /.github/how_to_use_github_to_contribute_to_gudhi.md
parente15431ead82923a939f9bcc66347c1b718618a98 (diff)
Mention git submodule sync
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.md7
1 files changed, 4 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 6ab05e36..747ca39b 100644
--- a/.github/how_to_use_github_to_contribute_to_gudhi.md
+++ b/.github/how_to_use_github_to_contribute_to_gudhi.md
@@ -25,10 +25,10 @@ This creates a directory gudhi-devel, which you are free to move around or renam
cd gudhi-devel
```
-Everytime you clone the repository, you will have to download the *submodules*.
+When you clone the repository, you also need to download the *submodules*.
## Submodules
-An interface to Hera for Wasserstein distance is available on an external git repository. To download it:
+Hera, used for Wasserstein distance, is available on an external git repository. To download it:
```bash
git submodule update --init
```
@@ -60,8 +60,9 @@ 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:
+**Reminder:** If the version of a submodule has changed, or if a submodule was added, you may need to:
```bash
+git submodule sync
git submodule update --init
```