aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..78040f0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+### Dialog Interactive Fiction Starter Kit
+<hr/>
+
+This repo contains starter kit for developing Interactive Fiction using [`Dialog language`][dialog]. Includes a powershell script to generate a web version of the game
+
+> Script assumes you have already installed [`dialog`][dialog] and [`Å-machine VM`][a-machine] in your system path. Also you have to copy stdlib.dg from the dialog folder to your game root path.
+
+### IFID
+Make sure you have replaced your story with a new `IFID` in `story.dg`.
+> You can easily generate `IFID` using [`IFID generator`][dialog] available at [dialog website][dialog].
+
+[dialog]: https://www.linusakesson.net/dialog/
+[a-machine]: https://www.linusakesson.net/dialog/aamachine/index.php \ No newline at end of file