Revised readme using proper markdown

1 files changed, 67 insertions, 0 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.
+
+