diff options
| author | Stephen Sinclair <radarsat1@gmail.com> | 2017-10-18 10:15:54 -0300 |
|---|---|---|
| committer | Stephen Sinclair <radarsat1@gmail.com> | 2017-10-18 10:16:04 -0300 |
| commit | 853e5b7cde233394a80acbf5ae169a416c8ee105 (patch) | |
| tree | dda91a4638db6b31e50ff65b2d4e9062a2b104b3 | |
| parent | 8b543a2850d9d24f85cca9229169fe5027ab863e (diff) | |
Reformat readme as markdown.
| -rw-r--r-- | README.md (renamed from readme) | 18 |
1 files changed, 10 insertions, 8 deletions
@@ -1,15 +1,17 @@ -RtAudio - a set of C++ classes that 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. +# RtAudio + +A set of C++ classes that 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-2017 (and many other developers!) This distribution of RtAudio contains the following: -doc: RtAudio documentation (see doc/html/index.html) -tests: example RtAudio programs -include: header and source files necessary for ASIO, DS & OSS compilation -tests/Windows: Visual C++ .net test program workspace and projects +- doc: RtAudio documentation (see doc/html/index.html) +- tests: example RtAudio programs +- include: header and source files necessary for ASIO, DS & OSS compilation +- tests/Windows: Visual C++ .net test program workspace and projects -OVERVIEW: +## Overview RtAudio is a set of C++ classes that provides a common API (Application Programming Interface) for realtime audio input/output across Linux (native ALSA, JACK, PulseAudio and OSS), Macintosh OS X and Windows (DirectSound, ASIO and WASAPI) operating systems. RtAudio significantly simplifies the process of interacting with computer audio hardware. It was designed with the following objectives: @@ -24,12 +26,12 @@ RtAudio is a set of C++ classes that provides a common API (Application Programm RtAudio incorporates the concept of audio streams, which represent audio output (playback) and/or input (recording). Available audio devices and their capabilities can be enumerated and then specified when opening a stream. Where applicable, multiple API support can be compiled and a particular API specified when creating an RtAudio instance. See the \ref apinotes section for information specific to each of the supported audio APIs. -FURTHER READING: +## Further Reading For complete documentation on RtAudio, see the doc directory of the distribution or surf to http://www.music.mcgill.ca/~gary/rtaudio/. -LEGAL AND ETHICAL: +## Legal and ethical: The RtAudio license is similar to the MIT License. |