summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGrant Shangreaux <grant@unabridgedsoftware.com>2022-01-22 14:05:01 -0600
committerGrant Shangreaux <grant@unabridgedsoftware.com>2022-01-22 14:05:01 -0600
commit7879a9a52bd35254a72db4f310b121911a5c2dcb (patch)
treef46e368750591298d615e3005de6862f6d6c244a
parent0678f718e61f23ef846a942449ab2e042526f16e (diff)
Docs: basic README.md file
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e41b924
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Elisp Wink Mafia
+
+I'm interested in creating some kind of murder mystery game, and decided to
+start by implementing an AI that can play the game of "if the killer winks
+at you, you're dead".
+
+
+The program is in the [Emacs org-mode document, mafia.org](./mafia.org).
+You should be able to run it by opening it in Emacs and evaluating the
+main source block `mafia` by pressing `C-c C-c` with your cursor on it.
+Then the command `mafia-play` will be available which will simulate the
+"game" at whatever point this code is at.