]> Repos - portaudio/commitdiff
Fix doc and examples references in README.md
authorRoss Bencina <rossb@audiomulch.com>
Thu, 24 Sep 2020 04:11:42 +0000 (14:11 +1000)
committerGitHub <noreply@github.com>
Thu, 24 Sep 2020 04:11:42 +0000 (14:11 +1000)
README.md

index fde45560b7b1255a77595ea2018f137a6251420b..919ab313123a084999d597c2c7a4d1ef5af5d2bb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,10 +9,10 @@ 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 is available at http://www.portaudio.com/docs/
+* Or at `/doc/html/index.html` after running Doxygen.
+* Also see `src/common/portaudio.h` for the API spec.
+* And see the `examples/` and `test/` directories for many examples of usage. (We suggest `examples/paex_saw.c` for an example.)
 
 For information on compiling programs with PortAudio, please see the
 tutorial at: