summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2013-03-26 22:37:20 -0700
committerSebastian Thiel <byronimo@gmail.com>2013-03-26 22:37:20 -0700
commit6dc4e66f8bf4a660d0beb204775fb518baf3a14f (patch)
tree8914848abf25ab4dcf6336796134daac556ae24a
parent0e90a8f61cf8c8eb346ad6dc0460cc00417733c7 (diff)
parent8f349e329af9902b71430b5112f9cff3cdc0a995 (diff)
downloadgitpython-6dc4e66f8bf4a660d0beb204775fb518baf3a14f.tar.gz
Merge pull request #104 from esc/fixup/doc/intro
Fixup/doc/intro
-rw-r--r--doc/source/intro.rst40
1 files changed, 23 insertions, 17 deletions
diff --git a/doc/source/intro.rst b/doc/source/intro.rst
index 520cf159..633bf398 100644
--- a/doc/source/intro.rst
+++ b/doc/source/intro.rst
@@ -19,7 +19,7 @@ Requirements
* `GitDB`_ - a pure python git database implementation
* `async`_ - asynchronous task scheduling
-
+
* `Python Nose`_ - used for running the tests
* `Mock by Michael Foord`_ used for tests. Requires version 0.5
@@ -36,9 +36,9 @@ Installing GitPython is easily done using
`setuptools`_. Assuming it is
installed, just run the following from the command-line:
-.. sourcecode:: none
+.. sourcecode:: console
- # easy_install GitPython
+ $ easy_install GitPython
This command will download the latest version of GitPython from the
`Python Package Index <http://pypi.python.org/pypi/GitPython>`_ and install it
@@ -54,10 +54,10 @@ here:
Alternatively, you can install from the distribution using the ``setup.py``
script:
-.. sourcecode:: none
+.. sourcecode:: console
+
+ $ python setup.py install
- # python setup.py install
-
.. 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.
Getting Started
@@ -80,21 +80,27 @@ Source Code
GitPython's git repo is available on GitHub, which can be browsed at:
- * https://github.com/gitpython-developers/GitPython
+* https://github.com/gitpython-developers/GitPython
+
+and cloned using:
+
+.. sourcecode:: console
+
+ $ git clone git://github.com/gitpython-developers/GitPython.git git-python
+
+Initialize all submodules to obtain the required dependencies with:
-and cloned using::
+.. sourcecode:: console
- $ git clone git://github.com/gitpython-developers/GitPython.git git-python
-
-Initialize all submodules to obtain the required dependencies with::
-
$ cd git-python
$ git submodule update --init --recursive
-
-Finally verify the installation by running the `nose powered <http://code.google.com/p/python-nose/>`_ unit tests::
-
+
+Finally verify the installation by running the `nose powered <http://code.google.com/p/python-nose/>`_ unit tests:
+
+.. sourcecode:: console
+
$ nosetests
-
+
Mailing List
============
http://groups.google.com/group/git-python
@@ -104,7 +110,7 @@ Issue Tracker
The issue tracker is hosted by github:
https://github.com/gitpython-developers/GitPython/issues
-
+
License Information
===================
GitPython is licensed under the New BSD License. See the LICENSE file for