README

libsndfile is a library of C routines for reading and writing
files containing sampled audio data.

The src/ directory contains the source code for library itself.

The doc/ directory contains the libsndfile documentation.

The examples/ directory contains examples of how to write code using
libsndfile.

The tests/ directory contains programs which link against libsndfile
and test its functionality.

The src/GSM610 directory contains code written by Jutta Degener and Carsten
Bormann. Their original code can be found at :
    http://kbs.cs.tu-berlin.de/~jutta/toast.html

The src/G72x directory contains code written and released by Sun Microsystems
under a suitably free license.

The src/ALAC directory contains code written and released by Apple Inc and
released under the Apache license.


LINUX
-----
Wherever possible, you should use the packages supplied by your Linux
distribution.

If you really do need to compile from source it should be as easy as:

		./configure
		make
		make install

Since libsndfile optionally links against libFLAC, libogg, libvorbis and
libopus, you will need to install appropriate versions of these libraries
before running configure as above.

You can use CMake now to build under Linux, also under Windows and MacOS, see
README.md for details. CMake toolchain is usable, but still exterimental.


UNIX
----
Compile as for Linux.


Win32/Win64
-----------

Official Windows binaries are compiled with Autotools and MinGW, but you can use
CMake to generate solution for Visual Studio. Details are described in
README.md.

It is still recommended to use the libsndfile binaries available on the
libsndfile web site.

MacOSX
------
Building on MacOSX should be the same as building it on any other Unix.


CONTACTS
--------

libsndfile was written by Erik de Castro Lopo (erikd AT mega-nerd DOT com).
The libsndfile home page is at :

	http://libsndfile.github.io/libsndfile/

Bugs and support questions can be raised at :

	https://github.com/libsndfile/libsndfile/issues