Skip to content

Commit 07ae8fd

Browse files
author
Bastian Bechtold
committed
adds instructions on compiling the wheels to README
1 parent aa5ea86 commit 07ae8fd

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Installation
6262
------------
6363

6464
The ``soundfile`` module depends on the Python packages CFFI and NumPy, and the
65-
system library libsndfile.
65+
library libsndfile.
6666

6767
In a modern Python, you can use ``pip install soundfile`` to download
6868
and install the latest release of the ``soundfile`` module and its
@@ -79,6 +79,24 @@ Binaries for Python Extension Packages <http://www.lfd.uci.edu/~gohlke/pythonlib
7979

8080
.. _Anaconda: https://www.continuum.io/downloads
8181

82+
Building
83+
--------
84+
85+
``Soundfile`` itself does not contain any compiled code and can be
86+
bundled into a wheel with the usual ``python setup.py bdist_wheel``.
87+
However, ``soundfile`` relies on libsndfile, and optionally ships its
88+
own copy of libsndfile in the wheel.
89+
90+
To build a binary wheel that contains libsndfile, make sure to
91+
checkout and update the ``_soundfile_data`` submodule, then run
92+
``python setup.py bdist_wheel`` as usual. If the resulting file size
93+
of the wheel is around one megabyte, a matching libsndfile has been
94+
bundled (without libsndfile, it's around 25 KB).
95+
96+
To build binary wheels for all supported platforms, run ``python
97+
build_wheels.py``, which will ``python setup.py bdist_wheel`` for each
98+
of the platforms we have precompiled libsndfiles for.
99+
82100
Error Reporting
83101
---------------
84102

0 commit comments

Comments
 (0)