diff --git a/README.rst b/README.rst index 647a644..295ab39 100644 --- a/README.rst +++ b/README.rst @@ -38,7 +38,7 @@ interface for Python calling C code. CFFI is supported for CPython 2.6+, Breaking Changes ---------------- -The ``soundfile`` module has evolved rapidly during the last few releases. Most +The ``soundfile`` module has evolved rapidly in the past. Most notably, we changed the import name from ``import pysoundfile`` to ``import soundfile`` in 0.7. In 0.6, we cleaned up many small inconsistencies, particularly in the the ordering and naming of @@ -52,17 +52,25 @@ In 0.9.0, we changed the ``ctype`` arguments of the ``buffer_*`` methods to ``dtype``, using the Numpy ``dtype`` notation. The old ``ctype`` arguments still work, but are now officially deprecated. +In 0.12.0, we changed the load order of the libsndfile library. Now, +the packaged libsndfile in the platform-specific wheels is tried +before falling back to any system-provided libsndfile. If you would +prefer using the system-provided libsndfile, install the source +package or source wheel instead of the platform-specific wheels. + Installation ------------ The ``soundfile`` module depends on the Python packages CFFI and NumPy, and the -system library libsndfile. +library libsndfile. In a modern Python, you can use ``pip install soundfile`` to download -and install the latest release of the ``soundfile`` module and its dependencies. -On Windows and OS X, this will also install the library libsndfile. -On Linux, you need to install libsndfile using your distribution's -package manager, for example ``sudo apt-get install libsndfile1``. +and install the latest release of the ``soundfile`` module and its +dependencies. On Windows (64/32) and OS X (Intel/ARM) and Linux 64, +this will also install a current version of the library libsndfile. If +you install the source module, you need to install libsndfile using +your distribution's package manager, for example ``sudo apt install +libsndfile1``. If you are running on an unusual platform or if you are using an older version of Python, you might need to install NumPy and CFFI separately, @@ -71,6 +79,24 @@ Binaries for Python Extension Packages