summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2016-06-21 08:57:39 +0200
committerSebastian Thiel <byronimo@gmail.com>2016-06-21 09:05:39 +0200
commit3c6e5adab98a2ea4253fefc4f83598947f4993ee (patch)
treed88f90c257ba6267893df4445cafbe445ae3b0f0 /README.md
parentde894298780fd90c199ef9e3959a957a24084b14 (diff)
downloadgitpython-3c6e5adab98a2ea4253fefc4f83598947f4993ee.tar.gz
chore(tests): test-initialization via script
Fixes #478
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7daa8317..85983f0d 100644
--- a/README.md
+++ b/README.md
@@ -34,9 +34,19 @@ Both commands will install the required package dependencies.
A distribution package can be obtained for manual installation at:
http://pypi.python.org/pypi/GitPython
+
+If you like to clone from source, you can do it like so:
+
+```bash
+git clone https://github.com/gitpython-developers/GitPython
+git submodule update --init --recursive
+./init-tests-after-clone.sh
+```
### RUNNING TESTS
+*Important*: Right after cloning this repository, please be sure to have executed the `init-tests-after-clone.sh` script in the repository root. Otherwise you will encounter test failures.
+
The easiest way to run test is by using [tox](https://pypi.python.org/pypi/tox) a wrapper around virtualenv. It will take care of setting up environnements with the proper dependencies installed and execute test commands. To install it simply:
pip install tox
@@ -44,6 +54,9 @@ The easiest way to run test is by using [tox](https://pypi.python.org/pypi/tox)
Then run:
tox
+
+
+For more fine-grained control, you can use `nose`.
### Contributions