DMDirc-Meta/README.md

DMDirc

DMDirc is an IRC client written in Java. It’s cross-platform, hugely configurable, and is easily extensible with a robust plugins system.

This repository doesn’t actually contain the source for DMDirc. Instead it’s split over four different components, each with their own repository:

• client: contains the main guts of the client
• parser: an interface for parsers and a full IRC parser
• plugins: official plugins, including the main UI
• util: general purpose utility classes not directly related to IRC

Each of the repositories can be worked on and built independently of all the others (and we’ve paid particular care to make sure the parser and util projects can be dropped in to other applications with the minimum of fuss). If you actually want to develop the client, though, it’s a lot easier if they’re all together — that’s what this repository is for! Each of the components mentioned above is included as a submodule, and there are some handy top-level build scripts for bundling everything together.

Getting Started

First off, clone this repository and init the submodules:

git clone https://github.com/DMDirc/Meta.git
cd Meta
git submodule update --init --remote

You can then use the provided gradle wrapper to start a build, or run all the tests in the project:

./gradlew jar
./gradlew test

[Currently the gradle scripts do not generate a functioning client… we’re working on that still!]

Miscellaneous

Running Clover

Clover is disabled by default as it requires a license file we can’t distribute. 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:

./gradlew -PenableClover=1 cloverAggregateReports

This will place a HTML report in build/reports/clover/html.