From c82bf22f798a9d05aff6d8ba8ffa7d0117bc0fc5 Mon Sep 17 00:00:00 2001
From: Antoine Musso <hashar@free.fr>
Date: Fri, 21 Sep 2012 21:34:22 +0200
Subject: [PATCH] basic README for the newcomers

A tiny README file using the markdown syntax, gives out some hints as to
how one can install the prerequisites to jenkins-job.

Change-Id: I5577b09d9da0d74b8818799e399b570ffbbfcdfb
Reviewed-on: https://review.openstack.org/13494
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Approved: Monty Taylor <mordred@inaugust.com>
Reviewed-by: Monty Taylor <mordred@inaugust.com>
Tested-by: Jenkins
---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 000000000..d33f34592
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Jenkins Job Builder #
+
+Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format,
+and uses them to configure Jenkins. You can keep your job descriptions in human
+readable text format in a version control system to make changes and auditing
+easier. It also has a flexible template system, so creating many similarly
+configured jobs is easy.
+
+To install:
+    sudo python setup.py install
+
+Online documentation:
+- http://ci.openstack.org/jenkins-job-builder/
+
+
+## developers ##
+Bug report: https://bugs.launchpad.net/openstack-ci/
+
+Cloning: https://review.openstack.org/p/openstack-ci/jenkins-job-builder.git
+
+Patches are submitted via Gerrit at https://review.openstack.org/
+
+More details on how you can contribute is available on our wiki at:
+http://wiki.openstack.org/HowToContribute
+
+## installing wihout setup.py ##
+
+For YAML support, you will need libyaml installed.
+
+    # Mac OS X:
+    brew install libyaml
+
+Then install the required python packages using pip:
+
+    sudo pip install PyYAML jenkins
+