diff options
author | Jonathan "Duke" Leto <jonathan@leto.net> | 2011-04-29 10:33:36 -0700 |
---|---|---|
committer | Jonathan "Duke" Leto <jonathan@leto.net> | 2011-04-29 10:33:36 -0700 |
commit | 9e225c6b5d83311b9c522a4aca687c037933ee4a (patch) | |
tree | d1f8fcef5995619dc60d85a0ee568827db5a55ea | |
parent | ignore some module::build detritus (diff) | |
download | jitterbug-9e225c6b5d83311b9c522a4aca687c037933ee4a.tar.gz |
Add the beginning of docs about configuring Jitterbug
Diffstat (limited to '')
-rw-r--r-- | README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md index c42076a..388681d 100644 --- a/README.md +++ b/README.md @@ -47,3 +47,22 @@ Now, when you commit to a project that has a Jitterbug post-receive hook, the builder check periodically for a new task and build and test your projects! +### Configuring Jitterbug + +Take a look at example.yml, which uses all the advanced features of Jitterbug. +The easiest thing is to copy this file and tweak it to your needs. + +Most of the configuration changes that you will make are in the "jitterbug" and +"plugins" config keys. Under the "jitterbug" key we have the keys "reports", +"build", "build_process", "options", "branches" and "projects". Both the +"reports" and "build" keys take a "dir" key, such as: + + jitterbug: + reports: + dir: /tmp/jitterbug + build: + dir: /tmp/build + +This means that reports should be stored in /tmp/jitterbug and build directories will be stored +in /tmp/build. + |