aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJedidiah Barber <contact@jedbarber.id.au>2025-05-10 17:15:55 +1200
committerJedidiah Barber <contact@jedbarber.id.au>2025-05-10 17:15:55 +1200
commit03fe3aeb4d78b0528c26dff9d4a2ecbc4c323e0d (patch)
tree995c443347b76d4e53c64f0691427a389eb6ec77
parent155b22edb53d8587656270232abde0bd90a47f6a (diff)
Consolidated credits into a revised markdown readme
-rw-r--r--credit.txt5
-rw-r--r--readme.md33
-rw-r--r--readme.txt24
3 files changed, 33 insertions, 29 deletions
diff --git a/credit.txt b/credit.txt
deleted file mode 100644
index b5a6194..0000000
--- a/credit.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-
-This project was written and programmed by Jedidiah Barber.
-
-See http://jedbarber.id.au/ for other details.
-
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`.
+
+
diff --git a/readme.txt b/readme.txt
deleted file mode 100644
index 4d09bae..0000000
--- a/readme.txt
+++ /dev/null
@@ -1,24 +0,0 @@
-
-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
-
-