add some description

Cargo.toml

@@ -3,7 +3,7 @@ name = "bf-rs"
 version = "1.0.0"
 authors = ["Hikaru Terazono (3c1u) <[email protected]>"]
 edition = "2018"
-
+license = "MIT OR Apache-2.0"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]

README.md

@@ -0,0 +1,39 @@
+# bf-rs
+
+**Fast** Brainfuck interpreter written in Rust.
+
+## Prerequisites
+
+* Rust toolchain (1.38.9 or greater)
+* LLVM 8.0
+
+## Installation
+
+```console
+cargo install --git https://github.com/3c1u/bf-rs.git
+```
+
+## Benchmarks
+
+This table shows the time taken to run the programs on interpreters. These results were measured on a MacBook Pro (Mid 2016, i7-6700HQ).
+
+| | bf-rs | bf-rs (opt) | [bfc](https://github.com/barracks510/bfc) | [bf02](https://github.com/3c1u/bf-interpreter) |
+|:--|:-|:-|:-|:--|
+|mandelbrot| 4.07 sec | 4.06 sec | 5.26 sec | 9.82 sec |
+|hanoi     | 0.72 sec | 1.61 sec | 0.38 sec | 1.06 sec |
+|long      | 2.28 sec | 1.07 sec | 2.51 sec | 7.30 sec |
+|bench     | 0.34 sec | 0.31 sec | 0.41 sec | 0.58 sec |
+
+## About example programs
+
+These are some programs that I have found online. I did not write any of them.
+
+* **bench.bf** Found on [here](https://github.com/kostya/benchmarks/tree/master/brainfuck). Shows the alphabets in a reverse order.
+* **mandelbrot.bf** Found on [here](https://github.com/kostya/benchmarks/tree/master/brainfuck). Prints a beautiful Mandelbrot set.
+* **hanoi.bf** Found on [here](https://github.com/fabianishere/brainfuck/blob/master/examples/hanoi.bf). Solves the Tower of Hanoi problem.
+* **long.bf** Obtained from [bfc](https://github.com/barracks510/bfc) repositiory.
+* **oobrain.bf** Obtained from [here](https://github.com/Borisvl/brainfuck/blob/master/src/test/resources/bf/oobrain.b). Used for testing proper `u8` handling.
+
+## License
+
+This program is lisensed under the Apache License 2.0 and MIT License.

examples/long.bf

@@ -0,0 +1,25 @@
+>+>+>+>+>++<[>[<+++>-
+
+  >>>>>
+  >+>+>+>+>++<[>[<+++>-
+
+    >>>>>
+    >+>+>+>+>++<[>[<+++>-
+
+      >>>>>
+      >+>+>+>+>++<[>[<+++>-
+
+        >>>>>
+        +++[->+++++<]>[-]<
+        <<<<<
+
+      ]<<]>[-]
+      <<<<<
+
+    ]<<]>[-]
+    <<<<<
+
+  ]<<]>[-]
+  <<<<<
+
+]<<]>.