1 files changed, 21 insertions, 0 deletions
diff --git a/tests/realtimeGC/readme.txt b/tests/realtimeGC/readme.txt
new file mode 100644
index 000000000..035a00001
--- /dev/null
+++ b/tests/realtimeGC/readme.txt
@@ -0,0 +1,21 @@
+Test the realtime GC without linking nimrtl.dll/so.
+
+Note, this is a long running test, default is 35 minutes. To change the
+the run time see RUNTIME in main.nim and main.c.
+
+You can build shared.nim, main.nim, and main.c by running make (nix systems)
+or maike.bat (Windows systems). They both assume GCC and that it's in your
+path. Output: shared.(dll/so), camin(.exe), nmain(.exe).
+
+To run the test: execute either nmain or cmain in a shell window.
+
+To build buy hand:
+
+  - build the shared object (shared.nim):
+
+    $ nim c shared.nim
+
+  - build the client executables:
+
+    $ nim c -o:nmain main.nim
+    $ gcc -o cmain main.c -ldl