aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlec Murphy <alec@noreply.localhost>2021-07-05 16:14:15 +0000
committerAlec Murphy <alec@noreply.localhost>2021-07-05 16:14:15 +0000
commit03469a83f0e33ae20c802680ce8bfcee09e14443 (patch)
treeb90b8a079c4f363d038a0e3673109eafdf48d1fa
parentfd8de0bd2e591365a70c5a122dfca7595d82b345 (diff)
Update 'README.md'
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index ce04414..c3101bf 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
# chocolate-doom
-Chocolate Doom Loader and Translation Layer for TempleOS \ No newline at end of file
+Chocolate Doom Loader and Translation Layer for TempleOS
+
+![chocolate-doom](https://git.checksum.fail/alec/chocolate-doom/raw/branch/master/preview.gif "chocolate-doom")
+
+# Usage
+
+Clone the repo, create a RedSea `ISO.C` image, `#include "Run";`
+
+The WAD file for the Shareware version of DOOM is included, other game WADs supported by chocolate-doom may or may not work, I have not tested them yet.
+
+I have not implemented save games yet; if you try to save your game, it will crash.
+
+# TODO
+
+- Sound support
+
+- Save games \ No newline at end of file