From 375802cb41f9189707c8742e6f802c78d934f0a5 Mon Sep 17 00:00:00 2001 From: Jedidiah Barber Date: Thu, 8 May 2025 15:23:35 +1200 Subject: Revised readme using proper markdown --- readme.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ readme.txt | 62 --------------------------------------------------------- 2 files changed, 67 insertions(+), 62 deletions(-) create mode 100644 readme.md delete mode 100644 readme.txt diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..7984a43 --- /dev/null +++ b/readme.md @@ -0,0 +1,67 @@ + +## libao Binding for the Ada Programming Language + +This a thick binding of [libao](https://xiph.org/ao/). So all the rough edges +of C have all been filed off. In particular: + + + +A short example program is available in the `example` subdirectory. + + + +#### Dependencies + +Build time: + + +Run time: + + + + +#### Building and Installation + +This repository is written to use the GNAT Project Manager build tools. To +build, use the following command + +`gprbuild aao.gpr` + +There is a single build switch of `-Xbuild` which can have a value of `release` +(the default) or `debug`. + +To install the binding, use + +`gprinstall -p -m aao.gpr` + +The other gpr file `example.gpr` can be used to build the short example +programs provided. + +For further information on the build tools, consult the +[GPRbuild docs](https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug.html). + + + +#### Credits and Licensing + +This binding and the short Ada example were written by Jedidiah Barber. + +The short C example program was written by Stan Seibert. + +All binding code and example programs are released into the public domain. +Consult `unlicense.txt` and the header of the C example program for further +information. + + diff --git a/readme.txt b/readme.txt deleted file mode 100644 index 8cb62c2..0000000 --- a/readme.txt +++ /dev/null @@ -1,62 +0,0 @@ - - -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_initialize/ao_shutdown are now automatic - * ao_option/Option_List objects are deallocated when they go out of scope - * ao_device/Device objects are automatically closed upon program end - * All error codes have been converted to exceptions - -A short example program is available in /example/. - - -Dependencies ------------- - -An Ada 2012 compiler and standard library (build) -A C compiler and standard library (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 -------------------- - -C 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 of this binding and example programs is released into the public -domain. Consult unlicense.txt and the header of the C example program for -further information. - - -- cgit