DrBrainf-ck/README.md
2018-12-05 20:46:54 +01:00

35 lines
930 B
Markdown

# DrBrainf\*ck
This is the repo for the PF1 final project of _Claudio Maggioni_ and
_Tommaso Rodolfo Masera_.
## Running
Run the file `gui.rkt` using *DrRacket* or the `racket` CLI tool.
A CLI version of the interpreter is avaliable. In order to run it, execute:
`./cli.rkt <name-of-file.bf>`
More documentation of this command is avaliable using the `-h` flag.
## Current features
- Brainf\*ck interpreter works for the instructions `[`, `]` `+`, `-`, `<`, `>`
, `.`, ',';
- Done simple editor GUI with *Run* button and output window.
- Editor supports basic syntax highlighting.
## Bugs
- No validation or user-friendly error handling.
## Feedback
### Add documentation about the language for someone that doesn't know it. How does it work? What are the instructions? What do they do? Example programs?
WIP
### In your "running" section explain how to run the interpreter without the GUI.
Done with `cli.rkt`.