summaryrefslogtreecommitdiff
path: root/ReadMe.md
diff options
context:
space:
mode:
Diffstat (limited to 'ReadMe.md')
-rw-r--r--ReadMe.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/ReadMe.md b/ReadMe.md
index c1ef208..f991b37 100644
--- a/ReadMe.md
+++ b/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
+```
+