aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4801bb8..ca029f6 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,5 @@
-This is a C compiler for the MAR ([Much-Assembly-Required](https://muchassemblyrequired.com/)) virtual machine. It is pretty unsophisticated at the moment, but should be able to compile VERY rudimentary C programs, like those in `test/`. Please patch in HWI calls yourself at the moment... \ No newline at end of file
+This is a C compiler for the MAR ([Much-Assembly-Required](https://muchassemblyrequired.com/)) virtual machine, written in C. It is pretty unsophisticated at the moment, but should be able to compile VERY rudimentary C programs, like those in `test/`. Please patch in HWI calls yourself at the moment...
+
+Note that even though this claims to be a "C compiler" written in C, it is *VERY* far from being able to compile itself.
+
+The compiler depends on `flex` and `bison`, and of course a working C compiler (tested with `clang` and `gcc`; the makefile uses `gcc`). Install those, then run `make` to build, and `./ccomp` to run.