Skip to content

Fixup/doc/intro #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 27, 2013
Merged

Fixup/doc/intro #104

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5abecd1
fix trailing whitespace
esc Mar 25, 2013
484f2e8
retab
esc Mar 25, 2013
8a4b81c
use proper synatx highlighting for shell commands
esc Mar 25, 2013
8f349e3
fix indentation of bullet
esc Mar 25, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 23 additions & 17 deletions doc/source/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down