aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6c125e4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# brainfuck
+
+A brainfuck interpreter
+
+## Build
+
+```
+make
+```
+
+## Hello World
+
+```
+./brainfuck ./helloworld.bf
+```
+
+## Lisp!
+
+```
+wget https://raw.githubusercontent.com/shinh/bflisp/master/bflisp.bf
+echo "(car (quote (a b c)))" | ./brainfuck bflisp.bf
+```
+
+WARNING: It's very slow, may takes ~10 minutes to run a `(car (quote (a b c)))`.
+
+## License
+
+You are free to copy, distribute and transmit this software for non-profit purposes under Non-Profit Open Software License 3.0.
+
+See LICENSE for details. \ No newline at end of file