From: Phil Burk <philburk@mobileer.com>
Date: Thu, 24 Sep 2020 03:36:04 +0000 (-0700)
Subject: Update and rename README.txt to README.md
X-Git-Tag: v19.7.0~118^2
X-Git-Url: https://andrewgundersen.net/repos?a=commitdiff_plain;h=7273b8de2755902aa1123fd15a9e53b3ca469159;p=portaudio

Update and rename README.txt to README.md

Use markdown
---

diff --git a/README.txt b/README.md
similarity index 54%
rename from README.txt
rename to README.md
index 2113827..fde4556 100644
--- a/README.txt
+++ b/README.md
@@ -1,42 +1,4 @@
-README for PortAudio
-
-/*
- * PortAudio Portable Real-Time Audio Library
- * Latest Version at: http://www.portaudio.com
- *
- * Copyright (c) 1999-2008 Phil Burk and Ross Bencina
- *
- * Permission is hereby granted, free of charge, to any person obtaining
- * a copy of this software and associated documentation files
- * (the "Software"), to deal in the Software without restriction,
- * including without limitation the rights to use, copy, modify, merge,
- * publish, distribute, sublicense, and/or sell copies of the Software,
- * and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be
- * included in all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
- * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
- * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
- * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
- * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
-/*
- * The text above constitutes the entire PortAudio license; however, 
- * the PortAudio community also makes the following non-binding requests:
- *
- * Any person wishing to distribute modifications to the Software is
- * requested to send the modifications to the original developer so that
- * they can be incorporated into the canonical version. It is also 
- * requested that these non-binding requests be included along with the 
- * license above.
- */
-
+# PortAudio - portable audio I/O library
 
 PortAudio is a portable audio I/O library designed for cross-platform
 support of audio. It uses either a callback mechanism to request audio 
@@ -45,12 +7,12 @@ native audio subsystem and the client. Audio can be processed in various
 formats, including 32 bit floating point, and will be converted to the 
 native format internally.
 
-Documentation:
-	Documentation is available in "/doc/html/index.html"
-	Also see "src/common/portaudio.h" for API spec.
-	Also see http://www.portaudio.com/docs/
-	And see the "test/" directory for many examples of usage
-		(we suggest "test/patest_saw.c" for an example)
+## Documentation:
+
+* Documentation is available in "/doc/html/index.html"
+* Also see "src/common/portaudio.h" for API spec.
+* Also see http://www.portaudio.com/docs/
+* And see the "test/" directory for many examples of usage. (we suggest "test/patest_saw.c" for an example)
 
 For information on compiling programs with PortAudio, please see the
 tutorial at:
@@ -60,8 +22,8 @@ tutorial at:
 We have an active mailing list for user and developer discussions.
 Please feel free to join. See http://www.portaudio.com for details.
 
+## Important Files and Folders:
 
-Important Files and Folders:
     include/portaudio.h     = header file for PortAudio API. Specifies API.	
     src/common/             = platform independant code, host independant 
                               code for all implementations.
@@ -69,7 +31,8 @@ Important Files and Folders:
     src/hostapi             = implementations for different host apis
 
 
-Host API Implementations:
+### Host API Implementations:
+
     src/hostapi/alsa        = Advanced Linux Sound Architecture (ALSA)
     src/hostapi/asihpi      = AudioScience HPI
     src/hostapi/asio        = ASIO for Windows and Macintosh
@@ -82,7 +45,8 @@ Host API Implementations:
     src/hostapi/wmme        = Windows MultiMedia Extensions (MME)
 
 
-Test Programs:
+### Test Programs:
+
     test/pa_fuzz.c         = guitar fuzz box
     test/pa_devs.c         = print a list of available devices
     test/pa_minlat.c       = determine minimum latency for your machine