Add readme

oleobal · Jun 15, 2019 · 26a7ba6 · 26a7ba6
1 parent 358d453
commit 26a7ba6
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/demo.gif b/demo.gif
diff --git a/main.d b/main.d
@@ -232,8 +232,6 @@ Switches:
 			if (d != dims)
 				//atomicStore(dims, d); // my code is radioactive
 				// OK so the above doesn't work.
-				// Why ?
-				// No. Fucking. Clue.
 				// maybe cause Tuple is a pointer type ? Idk.
 				// https://www.mail-archive.com/[email protected]/msg75050.html
 

diff --git a/readme.md b/readme.md
@@ -0,0 +1,15 @@
+## DOOM Fire
+
+A POSIX terminal implementation of (more or less) the PSX Doom fire,
+[as described by Fabien Sanglard](http://fabiensanglard.net/doom_fire_psx/).
+
+![Animated demo](demo.gif)
+
+### Usage
+
+Compile: `dmd main.d escapes.d -of=doom-fire`
+
+Get help: `./doom-fire --help`
+
+Run: `./doom-fire`
+