summaryrefslogtreecommitdiff
path: root/tests/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tests/README.md')
-rw-r--r--tests/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 000000000..3aeaaf464
--- /dev/null
+++ b/tests/README.md
@@ -0,0 +1,22 @@
+Writing Clar tests for libgit2
+==============================
+
+For information on the Clar testing framework and a detailed introduction
+please visit:
+
+https://github.com/vmg/clar
+
+
+* Write your modules and tests. Use good, meaningful names.
+
+* Make sure you actually build the tests by setting:
+
+ cmake -DBUILD_CLAR=ON build/
+
+* Test:
+
+ ./build/libgit2_clar
+
+* Make sure everything is fine.
+
+* Send your pull request. That's it.