summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2014-11-14 15:16:22 +0100
committerSebastian Thiel <byronimo@gmail.com>2014-11-14 15:31:40 +0100
commitd3e5d9cda8eae5b0f19ac25efada6d0b3b9e04e5 (patch)
tree92f685fcb107eab2942d72a215a053bbb35c4d3c /README.md
parent9c5b87bcdd70810a20308384b0e3d1665f6d2922 (diff)
downloadgitpython-d3e5d9cda8eae5b0f19ac25efada6d0b3b9e04e5.tar.gz
Updated README to better represent current state
Diffstat (limited to 'README.md')
-rw-r--r--README.md61
1 files changed, 25 insertions, 36 deletions
diff --git a/README.md b/README.md
index d2a858bf..a3800f92 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,9 @@ The object database implementation is optimized for handling large quantities of
### INSTALL
+[![Latest Version](https://pypip.in/version/GitPython/badge.svg)](https://pypi.python.org/pypi/GitPython/)
+[![Supported Python Versions](https://pypip.in/py_versions/GitPython/badge.svg)](https://pypi.python.org/pypi/GitPython/)
+
If you have downloaded the source code:
python setup.py install
@@ -28,6 +31,23 @@ A distribution package can be obtained for manual installation at:
http://pypi.python.org/pypi/GitPython
+### SOURCE
+
+GitPython's git repo is available on GitHub, which can be browsed at [github](https://github.com/gitpython-developers/GitPython) and cloned like that:
+
+ git clone git://github.com/gitpython-developers/GitPython.git git-python
+
+
+### INFRASTRUCTURE
+
+* [User Documentation](http://packages.python.org/GitPython/)
+* [Mailing List](http://groups.google.com/group/git-python)
+* [Issue Tracker](https://github.com/gitpython-developers/GitPython/issues)
+
+### LICENSE
+
+New BSD License. See the LICENSE file.
+
### DEVELOPMENT STATUS
[![Build Status](https://travis-ci.org/gitpython-developers/GitPython.svg?branch=0.3)](https://travis-ci.org/gitpython-developers/GitPython)
@@ -35,20 +55,21 @@ A distribution package can be obtained for manual installation at:
The project was idle for 2 years, the last release (v0.3.2 RC1) was made on July 2011. Reason for this might have been the project's dependency on me as sole active maintainer, which is an issue in itself.
-Now I am back and fully dedicated to pushing [OSS](https://github.com/Byron/bcore) forward in the realm of [digital content creation](http://gooseberry.blender.org/), and git-python will see some of my time as well. Therefore it will be moving forward, slowly but steadily.
+Now that there seems to be a massive user base, this should be motivation enough to let git-python return to a proper state, which means
+
+* no open pull requests
+* no open issues describing bugs
-In short, I want to make a new release of 0.3 with all contributions and fixes included, foster community building to facilitate contributions. Everything else is future.
+In short, I want to make a new release of 0.3 with all contributions and fixes included, foster community building to facilitate contributions.
#### PRESENT GOALS
The goals I have set for myself, in order, are as follows, all on branch 0.3.
* bring the test suite back online to work with the most commonly used git version
-* setup a travis test-matrix to test against a lower and upper git version as well
* merge all open pull requests, may there be a test-case or not, back. If something breaks, fix it if possible or let the contributor know
* conform git-python's structure and toolchain to the one used in my [other OSS projects](https://github.com/Byron/bcore)
* evaluate all open issues and close them if possible
-* create a new release of the 0.3 branch
* evaluate python 3.3 compatibility and establish it if possible
While that is happening, I will try hard to foster community around the project. This means being more responsive on the mailing list and in issues, as well as setting up clear guide lines about the [contribution](http://rfc.zeromq.org/spec:22) and maintenance workflow.
@@ -63,35 +84,3 @@ There has been a lot of work in the master branch, which is the direction I want
* make it work similarly to 0.3, but with the option to swap for at least one additional backend
* make a 1.0 release
* add backends as required
-
-### SOURCE
-
-
-GitPython's git repo is available on GitHub, which can be browsed at:
-
-https://github.com/gitpython-developers/GitPython
-
-and cloned using:
-
-git clone git://github.com/gitpython-developers/GitPython.git git-python
-
-
-### DOCUMENTATION
-
-The html-compiled documentation can be found at the following URL:
-
-http://packages.python.org/GitPython/
-
-### MAILING LIST
-
-http://groups.google.com/group/git-python
-
-### ISSUE TRACKER
-
-Issues are tracked on github:
-
-https://github.com/gitpython-developers/GitPython/issues
-
-### LICENSE
-
-New BSD License. See the LICENSE file.