From 296caf6cce8120bf3537f8ab05ddc4bc7273e859 Mon Sep 17 00:00:00 2001
From: Jakob Kaivo <jakob@kaivo.net>
Date: Thu, 13 Sep 2018 16:51:34 -0400
Subject: initial commit

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'README.md')

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`.
-- 
cgit v1.2.1