Fix use of bare repositories.
[jelmer/gitpython.git] / README
1 ==========
2 GitPython
3 ==========
4
5 GitPython is a python library used to interact with Git repositories.
6
7 GitPython is a port of the grit_ library in Ruby created by 
8 Tom Preston-Werner and Chris Wanstrath.
9
10 .. _grit: http://grit.rubyforge.org
11
12 REQUIREMENTS
13 ============
14
15 * Git_ tested with 1.5.3.7
16 * `Python Nose`_ - used for running the tests  
17 * `Mock by Michael Foord`_ used for tests
18
19 .. _Git: http://git.or.cz/
20 .. _Python Nose: http://code.google.com/p/python-nose/
21 .. _Mock by Michael Foord: http://www.voidspace.org.uk/python/mock.html
22
23 INSTALL
24 =======
25
26         python setup.py install
27
28 SOURCE
29 ======
30
31 GitPython's git repo is available on Gitorious, which can be browsed at:
32
33 http://gitorious.org/projects/git-python/
34
35 and cloned from:
36
37 git://gitorious.org/git-python/mainline.git
38
39 LICENSE
40 =======
41
42 New BSD License.  See the LICENSE file.