diff --git a/README.md b/README.md new file mode 100644 index 0000000..4e29faf --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# fLisp + +## See spec.md for the actual language and bytecode docs + +## Building + +Pre-requisites: +- yacc +- lex +- A C99 compiler +- GNU Make + +### Unix +Running `make` twice should work on most Unix systems. +It produces an executable called `flisp.amd64` + +### Windows +To meet the previously mentionned pre-requisites, you need to use mingw. +I recommend installing w64devkit, then compiling Bison and Flex from source. +Run `make win`, twice.