Skip to content

Commit e7cfa36

Browse files
committed
DOC: Minor changes to CONTRIBUTING
1 parent 230a623 commit e7cfa36

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

CONTRIBUTING.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,19 @@ newest development version from Github_::
1111

1212
git clone https://github.com/spatialaudio/jackclient-python.git
1313
cd jackclient-python
14-
python3 setup.py develop --user
15-
16-
.. _Github: https://github.com/spatialaudio/jackclient-python/
14+
python3 -m pip install --user -e .
1715

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

21-
If you prefer, you can also replace the last command with::
22-
23-
python3 -m pip install --user -e .
20+
.. _Github: https://github.com/spatialaudio/jackclient-python/
2421

25-
... where ``-e`` stands for ``--editable``.
22+
.. note::
2623

27-
Whenever the file ``jack_build.py`` changes (either because you edited it or it
28-
was updated by pulling from Github or switching branches), you have to run the
29-
last command again.
24+
Whenever the file ``jack_build.py`` changes (either because you edited it or
25+
it was updated by pulling from Github or switching branches), you have to
26+
run the last command again.
3027

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

0 commit comments

Comments
 (0)