ft: add readme
This commit is contained in:
19
README.md
Normal file
19
README.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# brainfuck-rs
|
||||
|
||||
This is a simple [brainfuck](https://en.wikipedia.org/wiki/Brainfuck) implementation is Rust
|
||||
|
||||
Why? Because I needed it for a university assignment.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Compile using `cargo`, then provide a file with the brainfuck code:
|
||||
```bash
|
||||
$ cargo run -- examples/hello_world.bf
|
||||
Hello World!
|
||||
```
|
||||
Also has some debug prints:
|
||||
```bash
|
||||
$ RUST_LOG=info cargo run -- examples/hello_world.bf
|
||||
$ RUST_LOG=debug cargo run -- examples/hello_world.bf
|
||||
```
|
||||
Reference in New Issue
Block a user