add readme

1 files changed, 13 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6e2f37f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# x86_64 Brainfuck Compiler
+
+This is a small brainfuck compiler I wrote, just for fun.
+It's written in *x86_64* assembly in GAS syntax.
+It directly writes an executable ELF file, that means it
+is completely standalone and does not need a linker or assembler.
+
+To compile your brainbuck program run the compiler with the following arguments:
+```sh
+./bfc [input file] [output file]
+```
+
+Use the provided `Makefile` to assemble the compiler.