aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJedidiah Barber <contact@jedbarber.id.au>2025-05-08 15:23:35 +1200
committerJedidiah Barber <contact@jedbarber.id.au>2025-05-08 15:23:35 +1200
commit375802cb41f9189707c8742e6f802c78d934f0a5 (patch)
treeb06a2c95f74dcca41cca43bd2a0b325966fd25b4
parenta75042055c9045d310c3ff1d30607be736e9cf5f (diff)
Revised readme using proper markdown
-rw-r--r--readme.md67
-rw-r--r--readme.txt62
2 files changed, 67 insertions, 62 deletions
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:
+
+<ul>
+ <li>ao_initialize/ao_shutdown are now automatic</li>
+ <li>ao_option/Option_List objects are deallocated when they go out of scope</li>
+ <li>ao_device/Device objects are automatically closed upon program end</li>
+ <li>All error codes have been converted to exceptions</li>
+</ul>
+
+A short example program is available in the `example` subdirectory.
+
+
+
+#### Dependencies
+
+Build time:
+<ul>
+ <li>gcc</li>
+ <li>GNAT</li>
+ <li>GPRbuild</li>
+ <li>libao</li>
+</ul>
+
+Run time:
+<ul>
+ <li>libao</li>
+</ul>
+
+
+
+#### 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.
-
-