README: initial guidelines

Signed-off-by: Fathi Boudra <fathi.boudra@linaro.org>

1 files changed, 23 insertions, 0 deletions

diff --git a/README b/README
index e69de29b..6ee3b628 100644
--- a/README
+++ b/README
@@ -0,0 +1,23 @@
+This repository contains the Jenkins job configurations used by Linaro CI.
+
+Jenkins job builder
+===================
+
+Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format,
+and uses them to configure Jenkins.
+
+Configurations
+==============
+
+In order to keep the jobs consistent, please follow this guideline:
+ * Job name
+   - lower case
+   - avoid spacing
+ * YAML
+   - file name matching the job name
+
+TODO
+====
+ * YAML header contains maintainer name
+ * enable markdown formatter
+