From 17ed86acaee20590b3ef4d1eea10f2fd27bd3350 Mon Sep 17 00:00:00 2001 From: Jedidiah Barber Date: Mon, 17 Jul 2023 00:59:56 +1200 Subject: Split binding into a minimal hierarchy, improved documentation slightly --- readme.txt | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) (limited to 'readme.txt') diff --git a/readme.txt b/readme.txt index 167f86a..71e6d46 100644 --- a/readme.txt +++ b/readme.txt @@ -8,13 +8,26 @@ Overview -------- This is a thick binding, so effort has been made to get rid of all C-isms and -C-specific types wherever possible. +C-specific types wherever possible. In particular: + + * Pa_Initialize and Pa_Terminate are now automatic + * All error codes have been converted to exceptions + * Void pointers are completely absent + +The package hierarchy is as follows: + + * Portaudio: Version information, exceptions, and a few common minor types + * Portaudio.Devices: Host_API and device related things + * Portaudio.Streams: Streams. sample buffers, and callbacks + +A few short example programs are available in /example/. Dependencies ------------ -GNAT (build) +An Ada 2012 compiler and standard library (build) +A C compiler and standard library (build) gprbuild (build) PortAudio (run) @@ -36,7 +49,7 @@ test programs provided. Further Information ------------------- -API of PortAudio: +C API of PortAudio: http://files.portaudio.com/docs/v19-doxydocs/portaudio_8h.html @@ -45,6 +58,7 @@ Credits and Legal This binding and the Ada test/example programs were written by Jedidiah Barber. -All code is released into the public domain. +All code of this binding and example programs is released into the public +domain. Consult unlicense.txt for further information. -- cgit