Basic readme and credits

2 files changed, 29 insertions, 0 deletions

diff --git a/credit.txt b/credit.txt
new file mode 100644
index 0000000..b5a6194
--- /dev/null
+++ b/credit.txt
@@ -0,0 +1,5 @@
+
+This project was written and programmed by Jedidiah Barber.
+
+See http://jedbarber.id.au/ for other details.
+
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..4d09bae
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,24 @@
+
+ASCII Fluid Simulator
+=====================
+
+
+This project duplicates the functionality of an ASCII fluid simulator written by Yusuke Endoh for
+an IOCCC entry in 2012. The original entry can be viewed at
+
+    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.
+
+
+
+To compile, use
+
+    gprbuild fluid.gpr
+
+and to run, redirect an input file into the program's standard input
+
+    bin/fluid < data/column.txt
+
+