Add README.md

README.md

@@ -0,0 +1,27 @@
+# bhfs
+brainfuck haskell is a compiler interpreter and JIT(WIP) suite for brainfuck made in haskell and llvm IR, all code in the reposotory is licensed under the GPL-3.0-or-later
+
+# building
+```sh
+nix build
+```
+or alternatively
+```sh
+cabal build
+```
+
+# devshell
+```sh
+nix develop
+```
+or just
+```
+direnv allow
+```
+if one uses direnv
+
+# usage
+all binaries ship with a `-h` argoument that prints a helpful message
+
+# why
+I wanted to learn IR and get better at haskell, this seemed the perfect opportunity