Skip to content

Commit

Permalink
Update various parts of the readme
Browse files Browse the repository at this point in the history
Either can be improved or have fallened out of date.
  • Loading branch information
michaeljones committed Feb 22, 2017
1 parent 8f2559a commit 150dd72
Showing 1 changed file with 35 additions and 11 deletions.
46 changes: 35 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Download
--------

Breathe is available from github and `PyPI, the Python Package Index
<http://pypi.python.org/pypi/breathe>`_
<http://pypi.python.org/pypi/breathe>`_. It can be installed with::

pip install breathe

Documentation
-------------
Expand All @@ -24,8 +26,8 @@ excellent service.
The source for the documentation is in the ``documentation`` folder if you want
to built it and read it locally.

Development
-----------
Note
~~~~

Breathe does not always get the attention it deserves but I am keen to keep it
moving forward. If you report an issue, please keep reminding me about it until
Expand All @@ -35,23 +37,42 @@ things so keep reminding me.
Testing
-------

Breathe doesn't have a set of tests at the moment. The documentation does a good
job of running the different parts of the Breathe functionality but there is
nothing to check that the output is appropriate.
The testsuite can be run with::

make dev-test

To build the documentation, run ``make`` in the root of the project.
The documentation also does a good effort of covering the available
functionality with different examples. To build the documentation, run::

make

This will run doxygen over the example code and then run the Breathe
documentation. View the results at::

documentation/build/html/index.html
documentation/build/html/index.html

Further to this if you want to compare the current documentation output against
a previous state in order to check for regressions there is a ``compare`` script
in the ``documentation`` folder. It takes two arguments which are two commit
references that you'd like to compare. This means that all your changes have to
be committed first. Also the script does not resolve state dependent references
like ``HEAD`` so provide concrete commit references like sha1s or branch names.
A typical example is to compare your current branch output to master::

# Make sure all your changes are committed first
cd documentation
./compare master my-branch

This will do a checkout and build at each commit and then run ``meld`` against
the resulting directories so you can see the differences introduced by your
branch.

Requirements
------------

Development is currently done with:

- Python 2.7.4
- Python 2.7
- Docutils 0.11
- Sphinx 1.4
- Doxygen 1.8.4
Expand All @@ -70,6 +91,9 @@ There is a mailing list available on Google groups:
The previous mailing list was on `librelist.com <http://librelist.com>`__ and the
archives are available `here <http://librelist.com/browser/breathe/>`__.

The mailing list is quieter than the Github repository so feel free to post
questions as Github issues.

Examples
--------

Expand Down Expand Up @@ -97,9 +121,9 @@ link in a github issue or get in touch on the mailing list.
Release
-------

Command for releasing source bundle & wheel to PyPI:
Command for releasing source bundle & wheel to PyPI::

python setup.py sdist bdist_wheel upload
python setup.py sdist bdist_wheel upload

Credits
-------
Expand Down

0 comments on commit 150dd72

Please sign in to comment.