Consolidated credits into a revised markdown readme

1 files changed, 33 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..5e20917
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,33 @@
+
+## ASCII Fluid Simulator
+
+This project duplicates the functionality of an ASCII fluid simulator written
+by Yusuke Endoh for an
+[IOCCC entry in 2012](https://web.archive.org/web/20190311013952/http://www.ioccc.org/2012/endoh1/).
+
+While the functionality was duplicated, the original code was too obfuscated to
+use as a guide and so this project was essentially written from scratch.
+
+
+
+#### Build Instructions
+
+To compile, use
+
+`gprbuild fluid.gpr`
+
+and to run, redirect an input file into the program's standard input
+
+`bin/fluid < data/column.txt`
+
+Several such input files can be found in the `data` subdirectory.
+
+
+
+#### Credits and Licensing
+
+Written by Jedidiah Barber.
+
+Licensed under the Sunset License v1.0. For details see `license.txt`.
+
+