From e91a05788ba7e765eca7df2c93ce2650a24d85fb Mon Sep 17 00:00:00 2001
From: Nathan Reiner <nathan@nathanreiner.xyz>
Date: Fri, 27 Dec 2024 13:49:18 +0100
Subject: add readme

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

(limited to 'README.md')

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.
-- 
cgit v1.2.3-70-g09d2