marCsweep/README.md

30 lines
769 B
Markdown
Raw Normal View History

2024-08-19 15:46:35 -04:00
# 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`.
2024-08-20 13:28:23 -04:00
Dependences: `git`, `make`, and `gcc`. Compiling with `clang` is also possible,
simply replace "gcc" with "clang" in the first line of the Makefile.
2024-08-19 15:54:19 -04:00
2024-08-19 15:46:35 -04:00
```
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!