Skip to content

Commit 896e564

Browse files
committed
DOC: update CONTRIBUTING
1 parent 7fcc112 commit 896e564

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

CONTRIBUTING.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,25 @@ https://github.com/spatialaudio/python-pa-ringbuffer/.
77
Contributions are always welcome!
88

99
Instead of pip-installing the latest release from PyPI_, you should get the
10-
newest development version with Git::
10+
newest development version (a.k.a. "master") with Git::
1111

1212
git clone https://github.com/spatialaudio/python-pa-ringbuffer.git
1313
cd python-pa-ringbuffer
14-
python3 setup.py develop --user
14+
python3 -m pip install -e . --user
1515

16-
.. _PyPI: https://pypi.python.org/pypi/pa-ringbuffer
16+
... where ``-e`` stands for ``--editable``.
1717

18-
This way, your installation always stays up-to-date, even if you pull new
19-
changes from the Github repository and if you switch between branches.
18+
When installing this way, you can quickly try other Git
19+
branches (in this example the branch is called "another-branch")::
2020

21-
If you prefer, you can also replace the last command with::
21+
git checkout another-branch
2222

23-
python3 -m pip install --user -e .
23+
If you want to go back to the "master" branch, use::
2424

25-
... where ``-e`` stands for ``--editable``.
25+
git checkout master
2626

27-
In both cases you can drop the ``--user`` flag if you want a system-wide
28-
installation (assuming you have the necessary rights).
27+
To get the latest changes from Github, use::
28+
29+
git pull --ff-only
30+
31+
.. _PyPI: https://pypi.python.org/pypi/pa-ringbuffer

0 commit comments

Comments
 (0)