diff options
| author | Sebastian Thiel <byronimo@gmail.com> | 2016-05-11 08:50:34 +0200 |
|---|---|---|
| committer | Sebastian Thiel <byronimo@gmail.com> | 2016-05-11 08:50:34 +0200 |
| commit | fb577c8a1eca8958415b76cde54d454618ac431e (patch) | |
| tree | 44b493b409ff45f99aa51af5cd112481a1fdfc7c | |
| parent | e73c80dd2dd1c82410fb1ee0e44eca6a73d9f052 (diff) | |
| parent | 895f0bc75ff96ce4d6f704a4145a4debc0d2da58 (diff) | |
| download | gitpython-fb577c8a1eca8958415b76cde54d454618ac431e.tar.gz | |
Merge pull request #429 from inderpreet99/fix-reqs-doc
Update requirements doc
| -rw-r--r-- | doc/source/intro.rst | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/doc/source/intro.rst b/doc/source/intro.rst index 78d40344..647323c4 100644 --- a/doc/source/intro.rst +++ b/doc/source/intro.rst @@ -13,6 +13,8 @@ The object database implementation is optimized for handling large quantities of Requirements ============ +* `Python`_ 2.7 or newer + Since GitPython 2.0.0 * `Git`_ 1.7.0 or newer It should also work with older versions, but it may be that some operations involving remotes will not work as expected. @@ -20,10 +22,11 @@ Requirements * `Python Nose`_ - used for running the tests * `Mock by Michael Foord`_ used for tests. Requires version 0.5 -.. _Git: http://git-scm.com/ -.. _Python Nose: http://code.google.com/p/python-nose/ +.. _Python: https://www.python.org +.. _Git: https://git-scm.com/ +.. _Python Nose: https://nose.readthedocs.io/en/latest/ .. _Mock by Michael Foord: http://www.voidspace.org.uk/python/mock.html -.. _GitDB: http://pypi.python.org/pypi/gitdb +.. _GitDB: https://pypi.python.org/pypi/gitdb Installing GitPython ==================== @@ -52,7 +55,7 @@ script: .. sourcecode:: none # python setup.py install - + .. note:: In this case, you have to manually install `GitDB`_ as well. It would be recommended to use the :ref:`git source repository <source-code-label>` in that case. Getting Started @@ -80,16 +83,16 @@ GitPython's git repo is available on GitHub, which can be browsed at: and cloned using:: $ git clone https://github.com/gitpython-developers/GitPython 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:: - + $ nosetests - + Questions and Answers ===================== Please use stackoverflow for questions, and don't forget to tag it with `gitpython` to assure the right people see the question in a timely manner. @@ -101,7 +104,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 |