diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..75a5997 --- /dev/null +++ b/README.MD @@ -0,0 +1,38 @@ +# The Spinny compiler and interpreter for itty. + +My custom string-based programming language, spinny, is being built here. + +Proper syntax and docs to come, but my current syntax example can be found [here](https://tilde.linuxposting.xyz/~mewrrythekibby/example.txt). + +## Building + +To build... + +1. `git clone` the itty repo into a folder itty +2. Run the `packager.sh` (note: requires Nix to work) + +## Running + +To install to itty, download the `spinny.yarn` file to your computer. Then go to an instance of itty and run the following commands: + +``` +loader upload spinny.yarn +# ^ This will open a file dialouge. +# Please select the downloaded `spinny.yarn'. +mrrp yarn spinny.yarn +# ^ This will ask you to confirm. +# Type `y' and press enter. +``` + +Now, spinny can be run by simply typing "spinny" on the command line. +Test it out by running `spinny --help`! + +## TODO + +- [x] Write tokenizer/parser thing +- [ ] Allow writing out compiled files +- [ ] Add interpreter +- [ ] Add some simple builtins +- [ ] Add itty binds/wrappers +- [ ] Spec and docs for spinny +- [ ] Make some standard (more complex) binds and add them