Include libyaml-test and libyaml-parser-emitter

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

diff --git a/tests/run-test-suite/src/ReadMe.md b/tests/run-test-suite/src/ReadMe.md
new file mode 100644 (file)
index 0000000..ced29cb
--- /dev/null
+++ b/tests/run-test-suite/src/ReadMe.md
@@ -0,0 +1,34 @@
+libyaml-parser-emitter
+======================
+
+Parser and Emitter CLI tools for libyaml
+
+# Synopsis
+
+```
+make build
+make test
+```
+
+# Usage
+
+Print parse events for a YAML file (or stdin):
+```
+./libyaml-parser file.yaml
+./libyaml-parser < file.yaml
+cat file.yaml | ./libyaml-parser
+```
+
+Print the YAML for a libyaml-parser events file (or stdin):
+```
+./libyaml-emitter file.events
+./libyaml-emitter < file.events
+cat file.events | ./libyaml-emitter
+```
+
+# Build
+
+```
+export LIBYAML_DIR=/path/to/libyaml   # Optional
+make build
+```