diff options
| -rw-r--r-- | README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..a45d383 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +cff is an experimental systems programming language. This is the compiler for +it. Use at your own risk, nothing is to be taken as stable right now. + +# Building + +### Bootstrapping + +The bootstrap compiler is written in C. This step only needs to be done once, +afterwards you can use your existing cff compiler executable. + +Requirements: gcc, latest release of LLVM. + +Run `bootstrap/bootstrap.sh`. Then run `make install` to install the compiler +to your PATH. + +### Building + +Requirements: an existing build of cff, latest release of LLVM + +Once you have the compiler installed in your PATH, simply build with `make` and +install with `make install`. + +# License + +See [LICENSE](./LICENSE). |