From: Mart Lubbers <mart@martlubbers.net>
Date: Thu, 25 Aug 2016 13:29:31 +0000 (+0200)
Subject: add readme
X-Git-Url: https://git.martlubbers.net/?a=commitdiff_plain;h=19a8fd12a1d7dbc6f9b5702923d0dcbe433db227;p=bf.git

add readme
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bf6671f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# bf, a brainfuck interpreter
+### Description
+This is my implementation of a [brainfuck][bf] interpreter. It uses a
+potentially infinite stack by reallocating more when necessary.
+
+### Installation
+Compiling is as easy as running `make`
+
+Cleaning up the mess can be done by running `make clean`
+
+### Usage
+Say you have a file containing a program on disk called `hello.bf`. Then you
+can run the file by running `./bf hello.bf`.
+
+### License
+Do what ever you want with this code.
+
+[bf]: https://en.wikipedia.org/wiki/Brainfuck