# HG changeset patch
# User Nolan Prescott <mail@nprescott.com>
# Date 1628906512 14400
#      Fri Aug 13 22:01:52 2021 -0400
# Node ID 05e498fd756f5c4a002cc9b6d4a8ade87a7e9a9e
# Parent  a596a983817548e17e5862dd0ca2d9c3e7884ab5
add README

diff --git a/README b/README
new file mode 100644
--- /dev/null
+++ b/README
@@ -0,0 +1,68 @@
+
+
+
+[Ook!]
+══════
+
+  A trivial substitution of another language with exactly one funny
+  twist. Where previously you may have implemented the necessary
+  instructions with individual opcodes or character instructions:
+
+  ━━━━━━━━━━━━━━━━━━━━━━━━
+   character  instruction 
+  ────────────────────────
+   >          shift right 
+   <          shift left  
+   +          increment   
+   -          decrement   
+   ,          input       
+   .          output      
+   [          begin loop  
+   ]          loop end    
+  ━━━━━━━━━━━━━━━━━━━━━━━━
+
+  You might also realize that 8 is really just 2^3 and reduce your
+  instruction set down to just Ook!, Ook?, Ook. and alternate the
+  pairwise combinations.
+
+  ━━━━━━━━━━━━━━━━━━━━━━━━━
+   token       instruction 
+  ─────────────────────────
+   Ook. Ook?   shift right 
+   Ook? Ook.   shift left  
+   Ook. Ook.   increment   
+   Ook! Ook!   decrement   
+   Ook. Ook!   input       
+   Oook! Ook.  output      
+   Ook! Ook?   begin loop  
+   Ook? Ook!   loop end    
+  ━━━━━━━━━━━━━━━━━━━━━━━━━
+
+
+[Ook!] https://esolangs.org/wiki/Ook!
+
+
+Use It
+══════
+
+  ┌────
+  │ (defun sierpinski ()
+  │   (ook Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook.
+  │        Ook. Ook! Ook? Ook. Ook? Ook. Ook. Ook. Ook? Ook. Ook. Ook. Ook. Ook. Ook.
+  │        Ook. Ook. Ook? Ook. Ook? Ook. Ook! Ook! Ook? Ook! Ook. Ook? Ook. Ook. Ook.
+  │        Ook. Ook. Ook? Ook. Ook? Ook. Ook. Ook? Ook. Ook! Ook? Ook! Ook! Ook! Ook?
+  │        Ook. Ook? Ook. Ook? Ook. Ook. Ook? Ook. Ook? Ook. Ook! Ook! Ook? Ook! Ook.
+  │        Ook. Ook. Ook? Ook. Ook? Ook? Ook! Ook. Ook? Ook. Ook. Ook! Ook? Ook! Ook!
+  │        Ook? Ook. Ook? Ook. Ook? Ook. Ook! Ook? Ook! Ook! Ook. Ook? Ook! Ook? Ook.
+  │        Ook. Ook! Ook? Ook! Ook! Ook? Ook! Ook. Ook. Ook. Ook? Ook. Ook. Ook. Ook.
+  │        Ook. Ook? Ook. Ook? Ook. Ook? Ook! Ook! Ook? Ook. Ook? Ook. Ook? Ook! Ook?
+  │        Ook. Ook! Ook? Ook? Ook. Ook? Ook! Ook. Ook? Ook. Ook? Ook. Ook. Ook. Ook.
+  │        Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook! Ook? Ook? Ook. Ook? Ook. Ook.
+  │        Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook. Ook? Ook. Ook? Ook! Ook!
+  │        Ook? Ook! Ook. Ook. Ook? Ook. Ook? Ook. Ook. Ook. Ook. Ook. Ook! Ook. Ook!
+  │        Ook? Ook! Ook! Ook? Ook! Ook? Ook. Ook? Ook. Ook? Ook! Ook. Ook? Ook! Ook.
+  │        Ook. Ook? Ook. Ook. Ook! Ook? Ook. Ook? Ook. Ook? Ook? Ook! Ook. Ook? Ook.
+  │        Ook. Ook? Ook!))
+  └────
+
+  Program output is written to a buffer `*Ook*'