Skip to content

Commit bc74b88

Browse files
Update install instructions
1 parent 667eb66 commit bc74b88

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,20 @@ rtmidi-python
44
Python wrapper for `RtMidi`_, the lightweight, cross-platform MIDI I/O
55
library. For Linux, Mac OS X and Windows.
66

7-
Setup
8-
-----
7+
Installation
8+
------------
99

10-
The wrapper is written in `Cython`_, but the generated C++ code is
11-
included, so you can install the module as usual::
10+
On Windows, the preferred way is to use one of the precompiled binaries
11+
available from `PyPI`_. On Linux and Mac OS X, the easiest way to install
12+
*rtmidi-python* is using pip::
13+
14+
pip install rtmidi-python
15+
16+
Alternatively, you can build the module from source as follows::
1217

1318
python setup.py install
1419

15-
If you want to build from the Cython source, make sure that you have a
20+
If you want to build from the `Cython`_ source, make sure that you have a
1621
recent version of Cython (>= 0.17), and run::
1722

1823
python setup.py install --from-cython
@@ -94,4 +99,5 @@ It uses `RtMidi`_, licensed under a modified MIT License, see
9499
RtMidi/RtMidi.h.
95100

96101
.. _RtMidi: http://www.music.mcgill.ca/~gary/rtmidi/
102+
.. _PyPI: https://pypi.python.org/pypi/rtmidi-python#downloads
97103
.. _Cython: http://www.cython.org

0 commit comments

Comments
 (0)