diff --git a/README.md b/README.md new file mode 100644 index 0000000..6df3086 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Clox + +This is my implmementation of the `clox` programming language, as seen from [Crafting Interpreters]. It makes use of the +[meson] build system. For convenience, there's also a `Makefile` included to simplify the (already pretty simple) meson commands. + +### Building + +```bash +make +``` + +To run the tests: + +```bash +make test +``` + +[Crafting Interpreters]: https://craftinginterpreters.com/ +[meson]: https://mesonbuild.com/