diff --git a/README.md b/README.md index 9c3262d..affc2e7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -= turingAutomaton = +# turingAutomaton # a toy programming language for creating turing machines -== description == +## description ## `turingAutomaton` is a programming language created to test the Racket ecosystem. it features custom syntax and is able to run single tape turing machines. -== installation == +## installation ## ``` git clone https://git.lain.church/tA/turingAutomaton @@ -14,7 +14,7 @@ cd turingAutomaton raco pkg install ``` -== syntax == +## syntax ## all files must begin with a @@ -49,7 +49,7 @@ comments are allowed: @ first ; or at the end of a line ``` -== sample program == +## sample program ## this machine will double a number passed to it @@ -86,7 +86,7 @@ c ~ a < fifth e ~ e > F ``` -== caveats == +## caveats ## currently very unfinished. @@ -96,12 +96,12 @@ there is no error checking until I learn how to do that. might get slow for very large tapes as the tape uses linked lists to operate. -== thanks == +## thanks ## mutce ckire to: * the racket team for creating an awesome language * Matthew Butterick for his book [Beautiful Racket](https://beautifulracket.com/) and the libraries within -== author == +## author ## `fi'e la ti'ei`