Skip to content

Commit 6dc4e66

Browse files
committed
Merge pull request #104 from esc/fixup/doc/intro
Fixup/doc/intro
2 parents 0e90a8f + 8f349e3 commit 6dc4e66

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

doc/source/intro.rst

+23-17
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Requirements
1919
* `GitDB`_ - a pure python git database implementation
2020

2121
* `async`_ - asynchronous task scheduling
22-
22+
2323
* `Python Nose`_ - used for running the tests
2424
* `Mock by Michael Foord`_ used for tests. Requires version 0.5
2525

@@ -36,9 +36,9 @@ Installing GitPython is easily done using
3636
`setuptools`_. Assuming it is
3737
installed, just run the following from the command-line:
3838

39-
.. sourcecode:: none
39+
.. sourcecode:: console
4040

41-
# easy_install GitPython
41+
$ easy_install GitPython
4242

4343
This command will download the latest version of GitPython from the
4444
`Python Package Index <http://pypi.python.org/pypi/GitPython>`_ and install it
@@ -54,10 +54,10 @@ here:
5454
Alternatively, you can install from the distribution using the ``setup.py``
5555
script:
5656

57-
.. sourcecode:: none
57+
.. sourcecode:: console
58+
59+
$ python setup.py install
5860

59-
# python setup.py install
60-
6161
.. note:: In this case, you have to manually install `GitDB`_ and `async`_ as well. It would be recommended to use the :ref:`git source repository <source-code-label>` in that case.
6262

6363
Getting Started
@@ -80,21 +80,27 @@ Source Code
8080

8181
GitPython's git repo is available on GitHub, which can be browsed at:
8282

83-
* https://github.com/gitpython-developers/GitPython
83+
* https://github.com/gitpython-developers/GitPython
84+
85+
and cloned using:
86+
87+
.. sourcecode:: console
88+
89+
$ git clone git://github.com/gitpython-developers/GitPython.git git-python
90+
91+
Initialize all submodules to obtain the required dependencies with:
8492

85-
and cloned using::
93+
.. sourcecode:: console
8694

87-
$ git clone git://github.com/gitpython-developers/GitPython.git git-python
88-
89-
Initialize all submodules to obtain the required dependencies with::
90-
9195
$ cd git-python
9296
$ git submodule update --init --recursive
93-
94-
Finally verify the installation by running the `nose powered <http://code.google.com/p/python-nose/>`_ unit tests::
95-
97+
98+
Finally verify the installation by running the `nose powered <http://code.google.com/p/python-nose/>`_ unit tests:
99+
100+
.. sourcecode:: console
101+
96102
$ nosetests
97-
103+
98104
Mailing List
99105
============
100106
http://groups.google.com/group/git-python
@@ -104,7 +110,7 @@ Issue Tracker
104110
The issue tracker is hosted by github:
105111

106112
https://github.com/gitpython-developers/GitPython/issues
107-
113+
108114
License Information
109115
===================
110116
GitPython is licensed under the New BSD License. See the LICENSE file for

0 commit comments

Comments
 (0)