a/marCsweep
1
0
Fork 0
mirror of https://codeberg.org/andyscott/marCsweep.git synced 2024-09-19 11:28:07 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added README

Browse source
This commit is contained in:
Andrew Scott 2024-08-19 15:46:35 -04:00
parent 3d55ec9731
commit 1d0ca65dcb
Signed by: a
GPG key ID: 7CD5A5977E4931C1
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md Normal file
View file

@ -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!