summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-03-22 10:25:27 +0100
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-03-22 10:25:27 +0100
commitbb6f10aff11e05baec2d2d10c544a2ea1c302bc6 (patch)
tree665b6fcbdf6c951d31206852a2d356ef103ada18 /.github
parentf78d65f0bd6aaf5f92639e2b809e1711acf929f7 (diff)
parent2ec0ac1f006577d520accbe605a61fc10ede3352 (diff)
Merge master and fix conflicts
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md2
-rw-r--r--.github/build-requirements.txt5
-rw-r--r--.github/how_to_use_github_to_contribute_to_gudhi.md7
-rw-r--r--.github/test-requirements.txt9
4 files changed, 19 insertions, 4 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 13d6cad7..a18ff8bd 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -19,7 +19,7 @@ There is a label **enhancement** in the [new issue](https://github.com/GUDHI/gud
## You are not familiar with GitHub ?
-Please take some time to read our [how to use GitHub to contribute to GUDHI](/home/vincent/workspace/gudhi/gudhi-devel/for_dev/how_to_use_github_to_contribute_to_gudhi.md).
+Please take some time to read our [how to use GitHub to contribute to GUDHI](how_to_use_github_to_contribute_to_gudhi.md).
## Something you want to improve in the documentation
diff --git a/.github/build-requirements.txt b/.github/build-requirements.txt
new file mode 100644
index 00000000..7de60d23
--- /dev/null
+++ b/.github/build-requirements.txt
@@ -0,0 +1,5 @@
+setuptools
+wheel
+numpy
+Cython
+pybind11 \ No newline at end of file
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
```
diff --git a/.github/test-requirements.txt b/.github/test-requirements.txt
new file mode 100644
index 00000000..18882792
--- /dev/null
+++ b/.github/test-requirements.txt
@@ -0,0 +1,9 @@
+pytest
+sphinx
+sphinxcontrib-bibtex
+sphinx-paramlinks
+matplotlib
+scipy
+scikit-learn
+POT
+tensorflow \ No newline at end of file