Rename install to install.txt, to avoid conflicts with "make install" target.
authorStephen Sinclair <radarsat1@gmail.com>
Fri, 12 Feb 2016 14:00:00 +0000 (11:00 -0300)
committerStephen Sinclair <radarsat1@gmail.com>
Fri, 12 Feb 2016 14:16:50 +0000 (11:16 -0300)
install [deleted file]
install.txt [new file with mode: 0644]

diff --git a/install b/install
deleted file mode 100644 (file)
index b2e8987..0000000
--- a/install
+++ /dev/null
@@ -1,56 +0,0 @@
-RtAudio - a set of C++ classes which provide a common API for realtime audio input/output across Linux (native ALSA, JACK, PulseAudio, and OSS), Macintosh OS X (CoreAudio and JACK), and Windows (DirectSound, ASIO and WASAPI) operating systems.
-
-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
-
-   If you checked out the code from git, please run "autoconf" before "./configure".
-
-3. Typing "make" will compile static and shared libraries.
-
-4. From within the "tests" directory, type "make" to compile the example programs.
-
-A few options can be passed to configure, including:
-
-  --enable-debug = enable various debug output
-  --with-alsa = choose native ALSA API support (linux only)
-  --with-pulse = choose native PulseAudio API support (linux only)
-  --with-oss = choose OSS API support (linux only)
-  --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.
-
-If you wish to use a different compiler than that selected by configure, specify that compiler in the command line (ex. to use CC):
-
-  ./configure CXX=CC
-
-
-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:
-
-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.
-
-
-LINUX OSS:
-
-The OSS API support in RtAudio has not been tested for many years.  I'm not even sure there are OSS drivers supporting recent linux kernels.  In all likelihood, the OSS API code in RtAudio will disappear within the next year or two (if you don't want this to happen, let me know).
diff --git a/install.txt b/install.txt
new file mode 100644 (file)
index 0000000..b2e8987
--- /dev/null
@@ -0,0 +1,56 @@
+RtAudio - a set of C++ classes which provide a common API for realtime audio input/output across Linux (native ALSA, JACK, PulseAudio, and OSS), Macintosh OS X (CoreAudio and JACK), and Windows (DirectSound, ASIO and WASAPI) operating systems.
+
+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
+
+   If you checked out the code from git, please run "autoconf" before "./configure".
+
+3. Typing "make" will compile static and shared libraries.
+
+4. From within the "tests" directory, type "make" to compile the example programs.
+
+A few options can be passed to configure, including:
+
+  --enable-debug = enable various debug output
+  --with-alsa = choose native ALSA API support (linux only)
+  --with-pulse = choose native PulseAudio API support (linux only)
+  --with-oss = choose OSS API support (linux only)
+  --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.
+
+If you wish to use a different compiler than that selected by configure, specify that compiler in the command line (ex. to use CC):
+
+  ./configure CXX=CC
+
+
+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:
+
+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.
+
+
+LINUX OSS:
+
+The OSS API support in RtAudio has not been tested for many years.  I'm not even sure there are OSS drivers supporting recent linux kernels.  In all likelihood, the OSS API code in RtAudio will disappear within the next year or two (if you don't want this to happen, let me know).