Added further information about the required submodules, and how to install them. Incremeneted version to 0.3.0 beta1

Byron · Byron · commit 28a33ca17ac5 · 2010-07-01T15:45:25.000+02:00
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.2.0-beta1
+0.3.0-beta1
diff --git a/doc/conf.py b/doc/conf.py
@@ -92,6 +92,10 @@
 # Options for HTML output
 # -----------------------
 
+html_theme_options = {
+    "stickysidebar": "true"
+}
+
 # The style sheet to use for HTML and HTML Help pages. A file of that name
 # must exist either in Sphinx' static/ path, or in one of the custom paths
 # given in html_static_path.
diff --git a/doc/intro.rst b/doc/intro.rst
@@ -13,13 +13,21 @@ The object database implementation is optimized for handling large quantities of
 Requirements
 ============
 
-* Tested with `Git`_ 1.7.0 or newer 
+* `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.
+* `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
 
 .. _Git: http://git-scm.com/
 .. _Python Nose: http://code.google.com/p/python-nose/
 .. _Mock by Michael Foord: http://www.voidspace.org.uk/python/mock.html
+.. _GitDB: http://pypi.python.org/pypi/gitdb
+.. _async: http://pypi.python.org/pypi/async
 
 Installing GitPython
 ====================
@@ -49,6 +57,8 @@ script:
 .. sourcecode:: none
 
     # 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
 ===============
@@ -63,6 +73,8 @@ API Reference
 
 An organized section of the GitPthon API is at :ref:`api_reference_toplevel`.
 
+.. _source-code-label:
+
 Source Code
 ===========
 
@@ -75,7 +87,16 @@ and cloned using::
 
 	$ git clone git://gitorious.org/git-python/mainline.git git-python
 	$ git clone git://github.com/Byron/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::
+    
+    $ nosetests
+    
 Mailing List
 ============
 http://groups.google.com/group/git-python
diff --git a/lib/git/ext/gitdb b/lib/git/ext/gitdb
@@ -1 +1 @@
-Subproject commit c265c97f9130d2225b923b427736796c0a0d957c
+Subproject commit 7562fdd96ab995f6c25fc102ef40a285283c844e
diff --git a/setup.py b/setup.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 try:
     from setuptools import setup, find_packages
 except ImportError:
@@ -54,22 +55,15 @@ def _stamp_version(filename):
       cmdclass={'build_py': build_py, 'sdist': sdist},
       version = VERSION,
       description = "Python Git Library",
-      author = "Michael Trier",
-      author_email = "mtrier@gmail.com",
+      author = "Sebastian Thiel, Michael Trier",
+      author_email = "byronimo@gmail.com, mtrier@gmail.com",
       url = "http://gitorious.org/projects/git-python/",
       packages = find_packages('lib'),
       package_dir = {'':'lib'},
       license = "BSD License",
+      requires=('gitdb (>=0.5)',),
       long_description = """\
-GitPython is a python library used to interact with Git repositories.
-
-GitPython provides object model access to your git repository. Once you have
-created a repository object, you can traverse it to find parent commit(s),
-trees, blobs, etc.
-
-GitPython is a port of the grit library in Ruby created by 
-Tom Preston-Werner and Chris Wanstrath.
-""",
+GitPython is a python library used to interact with Git repositories""",
       classifiers = [
         "Development Status :: 4 - Beta",
         "Intended Audience :: Developers",
