summaryrefslogtreecommitdiff
path: root/readme.txt
diff options
context:
space:
mode:
authorJedidiah Barber <contact@jedbarber.id.au>2023-06-19 22:15:44 +1200
committerJedidiah Barber <contact@jedbarber.id.au>2023-06-19 22:15:44 +1200
commit74af58587359206ef92249d18e4830c40cac0bc5 (patch)
tree8dfae06813f8e9f41787e45e7e31354b017f5713 /readme.txt
Initial commit
Diffstat (limited to 'readme.txt')
-rw-r--r--readme.txt54
1 files changed, 54 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..a0a3233
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,54 @@
+
+
+libao Binding for the Ada Programming Language
+==============================================
+
+
+Overview
+--------
+
+This a thick binding, so the rough edges of C have all been filed off. In
+particular ao_option/Option_List objects are automatically deallocated when
+they go out of scope, and any remaining open ao_device/Device objects are
+automatically closed when libao is shut down.
+
+
+Dependencies
+------------
+
+GNAT (build)
+gprbuild (build)
+libao (run)
+
+
+Build Instructions
+------------------
+
+Ensure that all dependencies are installed, including any developer or header
+packages for libao. Then the following commands will build and install the
+binding:
+
+ gprbuild aao.gpr
+ gprinstall -p -m aao.gpr
+
+The other gpr file, example.gpr, can be used to build the short example
+programs provided.
+
+
+Further Information
+-------------------
+
+API of libao:
+https://xiph.org/ao/doc/libao-api.html
+
+
+Credits and Legal
+-----------------
+
+This binding and the short Ada example were written by Jedidiah Barber.
+
+The short C example program was written by Stan Seibert.
+
+All code is released into the public domain.
+
+