unfuarked readme formatting

This commit is contained in:
Thorn Avery 2020-03-31 09:39:09 +13:00
parent 6288f19e93
commit 09fde58911

View File

@ -1,12 +1,12 @@
= turingAutomaton = # turingAutomaton #
a toy programming language for creating turing machines 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. `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 git clone https://git.lain.church/tA/turingAutomaton
@ -14,7 +14,7 @@ cd turingAutomaton
raco pkg install raco pkg install
``` ```
== syntax == ## syntax ##
all files must begin with a all files must begin with a
@ -49,7 +49,7 @@ comments are allowed:
@ first ; or at the end of a line @ first ; or at the end of a line
``` ```
== sample program == ## sample program ##
this machine will double a number passed to it this machine will double a number passed to it
@ -86,7 +86,7 @@ c ~ a < fifth
e ~ e > F e ~ e > F
``` ```
== caveats == ## caveats ##
currently very unfinished. 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. might get slow for very large tapes as the tape uses linked lists to operate.
== thanks == ## thanks ##
mutce ckire to: mutce ckire to:
* the racket team for creating an awesome language * the racket team for creating an awesome language
* Matthew Butterick for his book [Beautiful Racket](https://beautifulracket.com/) and the libraries within * Matthew Butterick for his book [Beautiful Racket](https://beautifulracket.com/) and the libraries within
== author == ## author ##
`fi'e la ti'ei` `fi'e la ti'ei`