Skip to content

Commit

Permalink
Revise and update the readme
Browse files Browse the repository at this point in the history
Changes worth mentioning:

- Format commands as code blocks instead of blockquotes.
  (This is particularly useful for the submodule update step, whose
  lines were inadvertently concatenated, but it also improves
  appearance overall.)

- Mention smmap as a requirement.
  (But also that it doesn't need to be separately installed.)

- Mention that gitdb-speedups is not currently maintained.

- No longer say gitdb has source code in gitorious.
  (Since that site no longer exists.)

- Call GitPython "GitPython" rather than "git-python".

- Replace the old git-python Google Groups link with a link to the
  Discussions page on the GitHub repository for GitPython.
  (This seems like the closest currently available resource.)
  • Loading branch information
EliahKagan committed Oct 20, 2023
1 parent 3d3e957 commit dfbfb12
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,38 @@ Installation
:target: https://readthedocs.org/projects/gitdb/?badge=latest
:alt: Documentation Status

From `PyPI <https://pypi.python.org/pypi/gitdb>`_
From `PyPI <https://pypi.python.org/pypi/gitdb>`_::

pip install gitdb

SPEEDUPS
========

If you want to go up to 20% faster, you can install gitdb-speedups with:
If you want to go up to 20% faster, you can install gitdb-speedups with::

pip install gitdb-speedups

However, please note that gitdb-speedups is not currently maintained.

REQUIREMENTS
============

* smmap - declared as a dependency, automatically installed
* pytest - for running the tests

SOURCE
======
The source is available in a git repository at gitorious and github:

The source is available in a git repository on GitHub:

https://github.com/gitpython-developers/gitdb

Once the clone is complete, please be sure to initialize the submodules using
Once the clone is complete, please be sure to initialize the submodule using::

cd gitdb
git submodule update --init

Run the tests with
Run the tests with::

pytest

Expand All @@ -53,13 +57,13 @@ DEVELOPMENT
.. image:: https://github.com/gitpython-developers/gitdb/workflows/Python%20package/badge.svg
:target: https://github.com/gitpython-developers/gitdb/actions

The library is considered mature, and not under active development. It's primary (known) use is in git-python.
The library is considered mature, and not under active development. Its primary (known) use is in GitPython.

INFRASTRUCTURE
==============

* Mailing List
* http://groups.google.com/group/git-python
* Discussions
* https://github.com/gitpython-developers/GitPython/discussions

* Issue Tracker
* https://github.com/gitpython-developers/gitdb/issues
Expand Down

0 comments on commit dfbfb12

Please sign in to comment.