diff options
1 files changed, 21 insertions, 0 deletions
| -rw-r--r-- | gctest/README.md | 21 |
diff --git a/gctest/README.md b/gctest/README.md new file mode 100644 index 0000000..57528fb --- /dev/null +++ b/gctest/README.md @@ -0,0 +1,21 @@ +# GC Test Bench
+
+A program to stress test garbage collector implementations.
+
+## Building
+
+The program is implemented as a static library, that has to be linked together
+with the garbage collector implementation to produce a test program.
+
+## Adding a new Garbage Collector implementation
+
+1. Implement the `GarbageCollector` interface from `gc.h` and the factory
+ function
+2. Add a new target in the `genie.lua` project
+
+## Running
+
+Running the program produces a `program.json` that can be open in
+`chrome://tracing` to allow analysis of the mutator vs garbage collector CPU
+usage and memory usage.
+
|