Add initial README.md and CONTRIBUTING.md

2 files changed, 52 insertions, 0 deletions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..d2f6952
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,25 @@
+# Contributing
+
+Before making a pull request
+1. Tidy your commits into the format below
+2. Deploy the playbook your self (if you have permissions)
+3. Does it work? If not, fix it and goto 1
+4. Create a pull request :)
+
+## Commit style
+
+Please create commits for each logical change,
+and use this format for your git commits
+
+```
+<role>: <task>: <change headline>
+
+< more descriptive text >
+```
+example:
+```
+jumbotron: irssi: cleanup .irssi/config
+
+Consistently indent everything with 2 spaces,
+and add a newline at end of file.
+```
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9b82fdb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Labitat Ansible
+
+Ansible playbooks for space infrastructure
+
+## Running ansible
+
+```
+ansible-playbook <playbook>.yml -D [-t <tag>[,<tag2>,..]] [-C]
+```
+- `<playbook>.yml`: the playbook you wish to run
+- `-D`: prints the changes made, fx. the difference between old and updated files
+- `-t <tag>`: limit the run to certain tags, tasks are usually tagged with their name
+- `-C`: don't make any changes, just show what would be changed
+
+example:
+```
+ansible-playbook jumbotron.yml -D -t irssi -C
+```
+
+This will log into the jumbotron server and show how the irssi configuration
+would be updated by your local changes in your ansible repo.
+
+```
+ansible-playbook jumbotron.yml -D -t irssi
+```
+This will actually do the changes, but again limit itself to just the tasks that are
+tagged `irssi`.