Skip to content

Commit ba21f57

Browse files
authored
DOC: update "installation" section (#36)
* DOC: update "installation" section * DOC: Remove the --user flag from the instructions
1 parent a7bc4f4 commit ba21f57

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

CONTRIBUTING.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ newest development version (a.k.a. "master") with Git::
1515

1616
git clone https://github.com/spatialaudio/python-rtmixer.git --recursive
1717
cd python-rtmixer
18-
python3 -m pip install -e . --user
18+
python3 -m pip install -e .
1919

2020
... where ``-e`` stands for ``--editable``.
2121

@@ -51,7 +51,7 @@ pages locally using Sphinx and check if they look OK.
5151
Initially, you might need to install a few packages that are needed to build the
5252
documentation::
5353

54-
python3 -m pip install -r doc/requirements.txt --user
54+
python3 -m pip install -r doc/requirements.txt
5555

5656
To (re-)build the HTML files, use::
5757

doc/installation.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
Installation
22
============
33

4-
On Windows, macOS, and Linux you can install a precompiled wheel with::
4+
On Windows, macOS and Linux you can install a precompiled "wheel" package with::
55

66
python3 -m pip install rtmixer
77

88
This will install ``rtmixer`` and its dependencies, including ``sounddevice``.
99

10+
Depending on your Python installation,
11+
you may have to use ``python`` instead of ``python3``.
12+
If you have installed the module already,
13+
you can use the ``--upgrade`` flag to get the newest release.
14+
1015
.. note:: On Linux, to use ``sounddevice`` and ``rtmixer`` you will need to
1116
have PortAudio installed, e.g. via ``sudo apt install libportaudio2``.
1217
On other platforms, PortAudio comes bundled with ``sounddevice``.
13-
14-
Developers can install in editable mode with some variant of::
15-
16-
git clone https://github.com/spatialaudio/python-rtmixer
17-
cd python-rtmixer
18-
git submodule update --init
19-
python3 -m pip install -e .

0 commit comments

Comments
 (0)