diff --git a/README.md b/README.md new file mode 100644 index 0000000..0d9fc06 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# marCsweep + +A mark-and-sweep garbage collector with a simple virtual machine to perform +allocations. + +## Building + +Compiling the project should be relatively easy, even if you aren't familiar +with `make`. + +``` +git clone https://codeberg.org/andyscott/marCsweep.git + +cd marCsweep + +make release +``` + +That's it! The Makefile will automatically create the build directory and place +the compiled executable there. + +## Notes + +This is a personal project that I am writing in my free time to learn more about +garbage collection. That said, please remember that it does allocate real +memory, which should not be taken lightly!