diff --git a/README.md b/README.md index 222afc6..f528458 100644 --- a/README.md +++ b/README.md @@ -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