Merge pull request #18 from csmith/master

Add some more bits and bobs to the README

README.md

@@ -27,6 +27,8 @@ scripts for bundling everything together.
 Getting Started
 --------------------------------------------------------------------------------
 
+### Project set up
+
 First off, clone this repository and init the submodules:
 
     git clone https://github.com/DMDirc/Meta.git
@@ -42,6 +44,55 @@ tests in the project:
 [Currently the gradle scripts do not generate a functioning client... we're
  working on that still!]
 
+### Using an IDE
+
+We strongly recommend using [IntelliJ IDEA](http://www.jetbrains.com/idea/).
+There are project files available in this repository which will load all of the
+subprojects properly, and configure IDEA with our preferred code style,
+license headers, etc. Simply open the `dmdirc.iml` file with IDEA to get going.
+
+Contributing
+--------------------------------------------------------------------------------
+
+### Client, Parser and Plugin repositories
+
+At present, we use Gerrit to perform code reviews for most of our repositories.
+This is tied fairly heavily into our continuous integration infra-structure.
+To push a change to Gerrit you'll need an account created by an admin - the
+easiest way to do that is to pop in to
+[#DMDirc on Quakenet](irc://quakenet.org/DMDirc) and we'll help you out. Once
+you have an account, the easiest way to push is to install the
+[git-review](https://github.com/openstack-infra/git-review) tool. You then
+simply change to a directory and use git-review:
+
+    cd client
+    git review
+    > remote: Resolving deltas: 100% (6/6)
+    > remote: Processing changes: new: 1, refs: 1, done
+    > remote:
+    > remote: New Changes:
+    > remote:   http://gerrit.dmdirc.com/12345
+    > remote:
+    > To ssh://user@dmdirc.com:29418/client
+    > * [new branch]      HEAD -> refs/publish/master
+
+Gerrit is configured to require 'Change-Id' lines to ease the process of pushing
+updated patchsets. The root gradle project contains a task to automatically
+install a commit message hook for each of the submodules; just execute:
+
+    ./gradlew installCommitIdHook
+
+### Meta and Util repositories
+
+For this repository and the util repository we welcome pull requests on GitHub.
+The tests for the module will run on Travis CI, and the pull request will be
+updated with the result.
+
+Please bear in mind that these are just unit tests for the individual modules —
+they don't test how your change will affect DMDirc itself. It's good practice
+to run all of the tests in the project and compile and run an actual client to
+make sure everything actually still works!
+
 Miscellaneous
 --------------------------------------------------------------------------------
 
@@ -52,8 +103,19 @@ When running clover tasks, the build script will try and download our license
 from a private webserver. If your IP isn't whitelisted you will need to supply
 a username/password.
 
-To enable clover, set the enableClover property to a true-ish value:
+To enable clover, set the enableClover property to true value:
 
-    ./gradlew -PenableClover=1 cloverAggregateReports
+    ./gradlew -PenableClover=true cloverAggregateReports
 
 This will place a HTML report in `build/reports/clover/html`.
+
+### Dependencies
+
+All cross-repository dependencies are specified as artifacts, rather than
+project dependencies. That means if (say) the client is compiled on its own,
+it will pull snapshot versions of the parser and util modules from our maven
+repository.
+
+The meta repository includes a gradle build script that finds these dependencies
+and replaces them with project links instead. This ensures that while developing
+the client your changes are reflected across modules properly.