From 85f9db12f55a49cc4b70eaa1e2111f0bcf358512 Mon Sep 17 00:00:00 2001
From: James Shubin <james@shubin.ca>
Date: Tue, 2 Feb 2016 10:48:01 -0500
Subject: [PATCH] Cleanup the README file

---
 README.md            | 27 ++++++++++++++++++++-------
 examples/graph0.yaml | 20 ++++++++++++++++++++
 examples/graph9.yaml |  2 +-
 3 files changed, 41 insertions(+), 8 deletions(-)
 create mode 100644 examples/graph0.yaml

diff --git a/README.md b/README.md
index 77464bad..61af8d82 100644
--- a/README.md
+++ b/README.md
@@ -5,18 +5,31 @@
 [![IRC](https://img.shields.io/irc/%23mgmtconfig.png)](https://webchat.freenode.net/?channels=#mgmtconfig)
 [![Jenkins](https://img.shields.io/jenkins/status.png)](https://ci.centos.org/job/purpleidea-mgmt/)
 
+## Community:
+Come join us on IRC in [#mgmtconfig](https://webchat.freenode.net/?channels=#mgmtconfig) on Freenode!
+You may like the [#mgmtconfig](https://twitter.com/hashtag/mgmtconfig) hashtag if you're on [Twitter](https://twitter.com/#!/purpleidea).
+
+## Questions:
+Please join the [#mgmtconfig](https://webchat.freenode.net/?channels=#mgmtconfig) IRC community!
+If you have a well phrased question that might benefit others, consider asking it by sending a patch to the documentation [FAQ](https://github.com/purpleidea/mgmt/blob/master/DOCUMENTATION.md#usage-and-frequently-asked-questions) section. I'll merge your question, and a patch with the answer!
+
+## Quick start:
+* Either get the golang dependencies on your own, or run `make deps` if you're comfortable with how we install them.
+* Run `make build` to get a fresh built `mgmt` binary.
+* Run `cd $(mktemp --tmpdir -d tmp.XXX) && etcd` to get etcd running. The `mgmt` software will do this automatically for you in the future.
+* Run `time ./mgmt run --file examples/graph0.yaml --converged-timeout=1` to try out a very simple example!
+* To run continuously in the default mode of operation, omit the `--converged-timeout` option.
+* Have fun hacking on our future technology!
+
+## Examples:
+Please look in the [examples/](examples/) folder for more examples!
+
 ## Documentation:
 Please see: [DOCUMENTATION.md](DOCUMENTATION.md) or [PDF](https://pdfdoc-purpleidea.rhcloud.com/pdf/https://github.com/purpleidea/mgmt/blob/master/DOCUMENTATION.md).
 
-## Questions:
-Come join us in [#mgmtconfig](https://webchat.freenode.net/?channels=#mgmtconfig) on Freenode!
-
-## Examples:
-Please look in the [examples/](examples/) folder!
-
 ## Bugs:
 Please set the `DEBUG` constant in [main.go](https://github.com/purpleidea/mgmt/blob/master/main.go) to `true`, and post the logs when you report the [issue](https://github.com/purpleidea/mgmt/issues).
-Bonus points if you provide an [OMV](https://github.com/purpleidea/mgmt/tree/master/test/omv) reproducible test case.
+Bonus points if you provide a [shell](https://github.com/purpleidea/mgmt/tree/master/test/shell) or [OMV](https://github.com/purpleidea/mgmt/tree/master/test/omv) reproducible test case.
 There are currently a few known bugs which I hope to squash soon.
 
 ## Notes:
diff --git a/examples/graph0.yaml b/examples/graph0.yaml
new file mode 100644
index 00000000..13f09cd3
--- /dev/null
+++ b/examples/graph0.yaml
@@ -0,0 +1,20 @@
+---
+graph: mygraph
+comment: hello world example
+types:
+  noop:
+  - name: noop1
+  file:
+  - name: file1
+    path: "/tmp/mgmt-hello-world"
+    content: |
+      hello world from @purpleidea
+    state: exists
+edges:
+- name: e1
+  from:
+    type: noop
+    name: noop1
+  to:
+    type: file
+    name: file1
diff --git a/examples/graph9.yaml b/examples/graph9.yaml
index 5846360a..37f36857 100644
--- a/examples/graph9.yaml
+++ b/examples/graph9.yaml
@@ -1,6 +1,6 @@
 ---
 graph: mygraph
-comment: simple exec fan in example to demonstrate optimization)
+comment: simple exec fan in example to demonstrate optimization
 types:
   exec:
   - name: exec1