summaryrefslogtreecommitdiff
path: root/README.md~
diff options
context:
space:
mode:
Diffstat (limited to 'README.md~')
-rw-r--r--README.md~39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md~ b/README.md~
new file mode 100644
index 0000000..c9c15f8
--- /dev/null
+++ b/README.md~
@@ -0,0 +1,39 @@
+# cOok
+The compiler for ook.
+
+As a reminder, ook is just [Brainf\*\*\*](https://esolangs.org/wiki/Brainfuck), but with these rules:
+| Ook | Brainf\*\*\* |
+|-----|-----------|
+| Ook. Ook? | > |
+| Ook? Ook. | < |
+| Ook. Ook. | + |
+| Ook! Ook! | - |
+| Ook! Ook. | . |
+| Ook. Ook! | , |
+| Ook! Ook? | [ |
+| Ook? Ook! | ] |
+
+*Make sure that there is exactly one space/newline between each ook, and that you add no extra code*
+
+# Windows
+
+The file extension of the file must be exactly 3 letters. A recommended file extension is *.ook.
+To compile ook, `cd` to the directory where cOok is installed, then run:
+```
+cd build/Windows
+cook <file>
+```
+
+# GNU/Linux
+
+To compile ook, `cd` to the directory where cOok is installed, then run:
+```
+cd build/GNULinux
+./cook <file>
+```
+
+If you want to compile the source, just run:
+```
+make
+```
+in the source directory.