Reorganisation of the repo and cleanup

[lttng-ci.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..d039527
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# LTTng configuration for Jenkins
+
+This repository holds the configuration of the LTTng Jenkins jobs. It is
+meant to be used with Jenkins Job Builder from the OpenStack Foundation.
+
+## Example Usage
+
+Generate XML files for Jenkins jobs from YAML files:
+
+    $ jenkins-jobs test jobs/ -o output/
+
+Update Jenkins jobs which name starts with "babeltrace":
+
+    $ jenkins-jobs --conf etc/jenkins_jobs.ini update jobs/ babeltrace*