Smol readme

1 files changed, 24 insertions, 0 deletions

diff --git a/readme.md b/readme.md
index e69de29..4090d8e 100644
--- a/readme.md
+++ b/readme.md
@@ -0,0 +1,24 @@
+# segfault-suite
+
+A small test framework that catches segmentation faults.
+
+## Dependencies
+
+1. POSIX compliant OS (`fork`, `waitpid`)
+
+## Usage
+
+```C
+#include "test-lib.h"
+
+int badTest() {
+  int* ptr = (int*)0;
+  *ptr = 5;
+  return 0;
+}
+
+int main() {
+  syncTest("badTest", "it segfaulted", badTest);
+  return 0;
+}
+```