Skip to content

Commit 650481e

Browse files
committed
docs: More readme / internal tweaks
1 parent 58484d5 commit 650481e

File tree

2 files changed

+20
-14
lines changed

2 files changed

+20
-14
lines changed

README.rst

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
|pypi| |docs| |build-status| |coverage| |license|
44

5-
Install:
5+
Setup
6+
-----
67

78
.. code-block:: sh
89
@@ -18,6 +19,8 @@ Open up python:
1819
$ pip install ptpython
1920
$ ptpython
2021
22+
Usage
23+
-----
2124
Create a `Repo`_ object of the project to inspect / checkout / update:
2225

2326
.. code-block:: python
@@ -59,17 +62,17 @@ See donation options at https://www.git-pull.com/support.html.
5962

6063
More information
6164
----------------
62-
Python support: Python 2.7, >= 3.4, pypy
63-
VCS supported: git(1), svn(1), hg(1)
64-
Source: https://github.com/vcs-python/libvcs
65-
Docs: https://libvcs.git-pull.com
66-
Changelog: https://libvcs.git-pull.com/history.html
67-
API: https://libvcs.git-pull.com/api.html
68-
Issues: https://github.com/vcs-python/libvcs/issues
69-
Test Coverage: https://codecov.io/gh/vcs-python/libvcs
70-
pypi: https://pypi.python.org/pypi/libvcs
71-
Open Hub: https://www.openhub.net/p/libvcs
72-
License: `MIT`_.
65+
- Python support: Python 2.7, >= 3.4, pypy
66+
- VCS supported: git(1), svn(1), hg(1)
67+
- Source: https://github.com/vcs-python/libvcs
68+
- Docs: https://libvcs.git-pull.com
69+
- Changelog: https://libvcs.git-pull.com/history.html
70+
- API: https://libvcs.git-pull.com/api.html
71+
- Issues: https://github.com/vcs-python/libvcs/issues
72+
- Test Coverage: https://codecov.io/gh/vcs-python/libvcs
73+
- pypi: https://pypi.python.org/pypi/libvcs
74+
- Open Hub: https://www.openhub.net/p/libvcs
75+
- License: `MIT`_.
7376

7477
.. _MIT: https://opensource.org/licenses/MIT
7578
.. _Documentation: https://libvcs.git-pull.com/

docs/index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,15 @@
33
```eval_rst
44
55
.. include:: ../README.rst
6-
:start-line: 4
7-
6+
:start-line: 3
7+
```
8+
9+
```eval_rst
810
.. toctree::
911
:maxdepth: 2
1012
:hidden:
1113
14+
index
1215
api
1316
developing
1417
history

0 commit comments

Comments
 (0)