aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--tests/conformance/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/tests/conformance/README.md b/tests/conformance/README.md
new file mode 100644
index 0000000..d7614fb
--- /dev/null
+++ b/tests/conformance/README.md
@@ -0,0 +1,17 @@
+# Building
+
+ $ protoc -I. --nim_out=. test_messages_proto3.proto
+ $ protoc -I. --nim_out=. conformance.proto
+ $ nim c conformance_nim.nim
+
+# Running conformance tests
+
+First you need to get protobuf library sources and build the library. After
+building, there should be `conformance/conformance-test-runner` that contains
+the actual test suite. The test runner communicates with the `conformance_nim`
+over pipes, passing in requests and receiving responses.
+
+Running the test suite (assuming your working directory is in
+`protobuf-src/conformance`):
+
+ $ ./conformance-test-runner /path/to/nimpb/tests/conformance/conformance_nim