Rewrite make test-suite

[libyaml.git] / tests / run-test-suite / ReadMe.md

diff --git a/tests/run-test-suite/ReadMe.md b/tests/run-test-suite/ReadMe.md
index c1ef208a3beda8c2eaf4df56ac10efd7f8cb93e8..f991b378e30495d527d9b11e82c30c49668a4699 100644 (file)
--- a/tests/run-test-suite/ReadMe.md
+++ b/tests/run-test-suite/ReadMe.md
@@ -1,17 +1,35 @@
 LibYAML Test Runner
 ===================
 
-Run libyaml-parser and libyaml-emitter against yaml-test-suite
+Run run-parser-test-suite and run-emitter-test-suite against yaml-test-suite
 
 # Synopsis
 
 ```
 make test
+# Run tests from yaml-test-suite
+make test-suite
 ```
 
 # Overview
 
 See:
 
-* https://github.com/yaml/libyaml
 * https://github.com/yaml/yaml-test-suite
+
+# Usage
+
+Print parse events for a YAML file (or stdin):
+```
+../run-parser-test-suite file.yaml
+../run-parser-test-suite < file.yaml
+cat file.yaml | ../run-parser-test-suite
+```
+
+Print the YAML for a libyaml-parser events file (or stdin):
+```
+../run-emitter-test-suite file.events
+../run-emitter-test-suite < file.events
+cat file.events | ../libyaml-run-test-suite
+```
+