Merge pull request #27 from TyounanMOTI/fix_wasapi_buffer_free_calloc

[rtaudio-cdist.git] / install

diff --git a/install b/install
index 2afaa41e0d41d9608c7b944528bd19fa5e19b5ad..b2e8987e87359743b92c70f33f75f5b5679e9705 100644 (file)
--- a/install
+++ b/install
@@ -5,6 +5,7 @@ By Gary P. Scavone, 2001-2014.
 To configure and compile (on Unix systems and MinGW):
 
 1. Unpack the RtAudio distribution (tar -xzf rtaudio-x.x.tar.gz).
+
 2. From within the directory containing this file, run configure:
 
    ./configure
@@ -24,6 +25,7 @@ A few options can be passed to configure, including:
   --with-jack = choose JACK server support (linux or Macintosh OS-X)
   --with-core = choose CoreAudio API support (Macintosh OS-X only)
   --with-asio = choose ASIO API support (windows only)
+  --with-wasapi = choose Windows Audio System API support (windows only)
   --with-ds = choose DirectSound API support (windows only)
 
 Typing "./configure --help" will display all the available options.  Note that you can provide more than one "--with-" flag to the configure script to enable multiple API support.
@@ -33,9 +35,18 @@ If you wish to use a different compiler than that selected by configure, specify
   ./configure CXX=CC
 
 
-WINDOWS USERS:
+CMAKE USAGE:
+
+CMake support is provided via the CMakeLists.txt files.  Assuming you have CMake installed on your system, a typical usage would involve the following steps (from within the parent distribution directory):
+
+mkdir _build_
+cd _build_
+cmake <path to CMakeLists.txt usually two dots> <options> e.g. cmake .. -DAUDIO_WINDOWS_WASAPI=ON
+
+
+WINDOWS:
 
-The DirectSound and ASIO APIs in RtAudio compile with either the MinGW compiler or MS Visual Studio.  The WASAPI API currently only compiles in MS Visual Studio.
+All Windows audio APIs in RtAudio compile with either the MinGW compiler (tested with latest tdm64-gcc-4.8.1) or MS Visual Studio.
 
 Visual C++ 6.0 project files (very old) are included for the test programs in the /tests/Windows/ directory.  These projects compile API support for ASIO, WASAPI and DirectSound.