summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index d564471..2f5cdb8 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
# Ouija Board
+Just a ouija board based on time and question randomness
+## Inspiration
+Inspired by Terry Davis TempleOS Timer Random Tongues which he used to communicate with God.
+
+Since TRT was written in HolyC and this random word generator is written in C I decided to call it a Ouija Board.
+
+![TempleOS Timer Random Tongues](images/image.png)
+
+## How to Use
+
+### Compile
+#### Portable
+`make`
+
+#### Installable
+`make install`
+
+### Run
+If you already have a `dictionary.dict` file in your path, just run:
+`ouija`
+
+If you have the file saved in another folder, just type:
+`ouija /path/to/dictionary`