summaryrefslogtreecommitdiff
path: root/lib/README
diff options
context:
space:
mode:
Diffstat (limited to 'lib/README')
-rw-r--r--lib/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/README b/lib/README
new file mode 100644
index 0000000..5d8b6d3
--- /dev/null
+++ b/lib/README
@@ -0,0 +1,17 @@
+
+ This directory contains the protocol-tests.
+
+ For the protocol "xxx" we must have:
+
+ - The file called xxx.rb
+
+ - The definition of class "XXXTest" - note upper-case
+
+ The class must implement the methods:
+
+ run_test()
+
+ error()
+
+ 'run_test' will be called to run the test, returning true if passed, and false
+ otherwise. In the event of a test failure 'error' will return something useful.