Skip to content

DOC: update "installation" section #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 5, 2020
Merged

DOC: update "installation" section #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec6a1d5
DOC: update "installation" section
mgeier Aug 27, 2020
f0036fd
DOC: Remove the --user flag from the instructions
mgeier Sep 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ newest development version (a.k.a. "master") with Git::

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

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

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

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

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

Expand Down
14 changes: 6 additions & 8 deletions doc/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
Installation
============

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

python3 -m pip install rtmixer

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

Depending on your Python installation,
you may have to use ``python`` instead of ``python3``.
If you have installed the module already,
you can use the ``--upgrade`` flag to get the newest release.

.. note:: On Linux, to use ``sounddevice`` and ``rtmixer`` you will need to
have PortAudio installed, e.g. via ``sudo apt install libportaudio2``.
On other platforms, PortAudio comes bundled with ``sounddevice``.

Developers can install in editable mode with some variant of::

git clone https://github.com/spatialaudio/python-rtmixer
cd python-rtmixer
git submodule update --init
python3 -m pip install -e .