summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README31
1 files changed, 19 insertions, 12 deletions
diff --git a/README b/README
index 9643dcf5..9473d447 100644
--- a/README
+++ b/README
@@ -4,37 +4,44 @@ GitPython
GitPython is a python library used to interact with Git repositories.
-GitPython is a port of the grit_ library in Ruby created by
+GitPython is a port of the grit library in Ruby created by
Tom Preston-Werner and Chris Wanstrath.
-.. _grit: http://grit.rubyforge.org
REQUIREMENTS
============
-* Git_ tested with 1.5.3.7
-* `Python Nose`_ - used for running the tests
-* `Mock by Michael Foord`_ used for tests. Requires 0.4
-
-.. _Git: http://git.or.cz/
-.. _Python Nose: http://code.google.com/p/python-nose/
-.. _Mock by Michael Foord: http://www.voidspace.org.uk/python/mock.html
+* Git ( tested with 1.5.3.7 )
+* Python Nose - used for running the tests
+* Mock by Michael Foord used for tests. Requires 0.5
INSTALL
=======
+If you have downloaded the source code:
python setup.py install
+
+or if you want to obtain a copy more easily:
+
+ easy_install gitpython
+
+A distribution package can be obtained for manual installation at:
+
+ http://pypi.python.org/pypi/GitPython
SOURCE
======
-GitPython's git repo is available on Gitorious, which can be browsed at:
+GitPython's git repo is available on Gitorious and GitHub, which can be browsed at:
http://gitorious.org/projects/git-python/
+http://github.com/Byron/GitPython
+
+and cloned using:
-and cloned from:
+git clone git://gitorious.org/git-python/mainline.git git-python
+git clone git://github.com/Byron/GitPython.git git-python
-git://gitorious.org/git-python/mainline.git
LICENSE
=======