X-Git-Url: https://gitweb.ps.run/toc/blobdiff_plain/9f94b672a5dc32da5ad01742bd4e976315a30d9c..c6ad2948bb98d42f8e0883ef82cd14cd2d5eda60:/ReadMe.md

diff --git a/ReadMe.md b/ReadMe.md
new file mode 100644
index 0000000..55cc5d8
--- /dev/null
+++ b/ReadMe.md
@@ -0,0 +1,10 @@
+# Building
+
+The project uses xmake (https://xmake.io/), see https://xmake.io/#/getting_started on how to set it up.
+It also depends on ANTLR, which is included in the repo.
+ANTLR has to be built using CMake and installed into the antlr4-cpp-runtime-4.9.2-source/install directory by invoking the INSTALL CMake target.
+The proejct can then be built by simply invoking `xmake` and can be run using the current directory as working directory by running `xmake run -w .`.
+
+All of the code is in src/ and the ANTLR grammar file is Toc.g4.
+
+The C++ code generated from the grammar is in gen/ and is up-to-date, but can be regenerated by running `java -jar antlr-4.9.2-complete.jar -Dlanguage=Cpp -no-listener -o gen Toc.g4`.
\ No newline at end of file