summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Kaivo <jakob@kaivo.net>2018-09-13 16:51:34 -0400
committerJakob Kaivo <jakob@kaivo.net>2018-09-13 16:51:34 -0400
commit296caf6cce8120bf3537f8ab05ddc4bc7273e859 (patch)
treea2c256114f3e07c381a193e4e33e4b54fc62ced7 /README.md
parent3dc6799453b87f5dea4d6941d5ccec359b719ecb (diff)
initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index ed7fe69..a528f63 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,15 @@
# bf
A very small Brainfuck interpreter
+
+To build, simply run make.
+
+Running the interpreter is simple:
+
+ $ ./bf input.bf
+
+The interpreter purposely does no error checking. If you don't specify an
+input file, it will crash. If there is an error reading the input file, it
+will crash.
+
+Program size is fixed at the same size as data space, which is controlled by
+`#define S`.