diff --git a/README.md b/README.md new file mode 100644 index 0000000..7cc8a76 --- /dev/null +++ b/README.md @@ -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 +```