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

README: add instructions for running the compiled program

Browse source
This commit is contained in:
Andrew Scott 2024-08-21 13:46:37 -04:00
parent dcc62257b3
commit 7a60c424be
Signed by: a
GPG key ID: 7CD5A5977E4931C1
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -22,6 +22,28 @@ make release
That's it! The Makefile will automatically create the build directory and place
the compiled executable there.
## Running
Once compiled, the program can be run with the following:
```
cd build # or debug
./gc
```
By default the program will output the results of the test cases:
> test_int_alloc: PASS
> test_pair_alloc: PASS
> test_obj_count: PASS
> test_pair_alloc: PASS
> test_unreachable: PASS
> test_auto_gc: PASS
If all six tests pass, then the library compiles correctly on your system and
should be ready for experimentation!
## Notes
This is a personal project that I am writing in my free time to learn more about