Skip to content

Revise and update the readme #103

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.

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 1 commit into from
Oct 20, 2023
Merged
Changes from all commits
Commits
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
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