Skip to content

Commit

Permalink
DOC: Minor changes to CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
mgeier committed Feb 19, 2018
1 parent 230a623 commit e7cfa36
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,19 @@ newest development version from Github_::

git clone https://github.com/spatialaudio/jackclient-python.git
cd jackclient-python
python3 setup.py develop --user

.. _Github: https://github.com/spatialaudio/jackclient-python/
python3 -m pip install --user -e .

... where ``-e`` stands for ``--editable``.
This way, your installation always stays up-to-date, even if you pull new
changes from the Github repository.

If you prefer, you can also replace the last command with::

python3 -m pip install --user -e .
.. _Github: https://github.com/spatialaudio/jackclient-python/

... where ``-e`` stands for ``--editable``.
.. note::

Whenever the file ``jack_build.py`` changes (either because you edited it or it
was updated by pulling from Github or switching branches), you have to run the
last command again.
Whenever the file ``jack_build.py`` changes (either because you edited it or
it was updated by pulling from Github or switching branches), you have to
run the last command again.

If you make changes to the documentation, you can locally re-create the HTML
pages using Sphinx_.
Expand Down

0 comments on commit e7cfa36

Please sign in to comment.