marCsweep/README.md

29 lines
714 B
Markdown

# 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`.
Dependences: `git`, `make`, and the C compiler of your choosing (the Makefile
assumes `gcc`).
```
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!