aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index 220e8f35..7daa8317 100644
--- a/README.md
+++ b/README.md
@@ -6,11 +6,13 @@ It provides abstractions of git objects for easy access of repository data, and
The object database implementation is optimized for handling large quantities of objects and large datasets, which is achieved by using low-level structures and data streaming.
+
### REQUIREMENTS
GitPython needs the `git` executable to be installed on the system and available in your `PATH` for most operations. If it is not in your `PATH`, you can help GitPython find it by setting the `GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
* Git (1.7.x or newer)
+* Python 2.7 to 3.5, while python 2.6 is supported on a *best-effort basis*.
The list of dependencies are listed in `./requirements.txt` and `./test-requirements.txt`. The installer takes care of installing them for you.
@@ -43,11 +45,9 @@ Then run:
tox
-### SOURCE
-
-GitPython's git repo is available on GitHub, which can be browsed at [github](https://github.com/gitpython-developers/GitPython) and cloned like that:
+### Contributions
- git clone https://github.com/gitpython-developers/GitPython
+Please have a look at the [contributions file][contributing].
### Live Coding
@@ -98,3 +98,4 @@ Now that there seems to be a massive user base, this should be motivation enough
[twitch-channel]: http://www.twitch.tv/byronimo/profile
[youtube-playlist]: https://www.youtube.com/playlist?list=PLMHbQxe1e9MnoEcLhn6Yhv5KAvpWkJbL0
+[contributing]: https://github.com/gitpython-developers/GitPython/blob/master/README.md \ No newline at end of file