summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorR. Tyler Croy <tyler@monkeypox.org>2012-07-08 20:58:44 -0700
committerR. Tyler Croy <tyler@monkeypox.org>2012-07-08 20:58:44 -0700
commit1bb2ef6b72a4e0f0cb22a6c9348a1c9c0b56ac54 (patch)
treec3cf4642b8ce9341314f7ab92fca97df0ad44967 /README.md
parent83bfb1f1553f69047366192ae562b082772a3712 (diff)
Add a Hacking section to the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index be7c60f..9c1f90c 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,16 @@ on a load balancer server. Currently Redhat family OSes are supported, but
support for other OS Families shouldn't be too difficult to merge in. Pull
requests accepted!
+## Hacking
+
+After cloning the repository, execute `git submodule update --init` to pull in
+any dependencies needed to test the module locally.
+
+1. `git submodule update --init`
+1. `rake spec` # To run the tests
+1. Hack Hack Hack # Adding tests hopefully!
+1. Commit and send a pull request!
+
## License
Apache 2.0