|
@@ -0,0 +1,43 @@
|
|
1
|
+DMDirc
|
|
2
|
+================================================================================
|
|
3
|
+
|
|
4
|
+DMDirc is an IRC client written in Java. It's cross-platform, hugely
|
|
5
|
+configurable, and is easily extensible with a robust plugins system.
|
|
6
|
+
|
|
7
|
+This repository doesn't actually contain the source for DMDirc. Instead it's
|
|
8
|
+split over four different components, each with their own repository:
|
|
9
|
+
|
|
10
|
+* [client](https://github.com/DMDirc/client):
|
|
11
|
+ contains the main guts of the client
|
|
12
|
+* [parser](https://github.com/DMDirc/parser):
|
|
13
|
+ an interface for parsers and a full IRC parser
|
|
14
|
+* [plugins](https://github.com/DMDirc/plugins):
|
|
15
|
+ official plugins, including the main UI
|
|
16
|
+* [util](https://github.com/DMDirc/util):
|
|
17
|
+ general purpose utility classes not directly related to IRC
|
|
18
|
+
|
|
19
|
+Each of the repositories can be worked on and built independently of all the
|
|
20
|
+others (and we've paid particular care to make sure the parser and util projects
|
|
21
|
+can be dropped in to other applications with the minimum of fuss). If you
|
|
22
|
+actually want to develop the client, though, it's a lot easier if they're all
|
|
23
|
+together — that's what this repository is for! Each of the components mentioned
|
|
24
|
+above is included as a submodule, and there are some handy top-level build
|
|
25
|
+scripts for bundling everything together.
|
|
26
|
+
|
|
27
|
+Getting Started
|
|
28
|
+--------------------------------------------------------------------------------
|
|
29
|
+
|
|
30
|
+First off, clone this repository and init the submodules:
|
|
31
|
+
|
|
32
|
+ git clone https://github.com/DMDirc/Meta.git
|
|
33
|
+ cd Meta
|
|
34
|
+ git submodule update --init --remote
|
|
35
|
+
|
|
36
|
+You can then use the provided gradle wrapper to start a build, or run all the
|
|
37
|
+tests in the project:
|
|
38
|
+
|
|
39
|
+ ./gradlew jar
|
|
40
|
+ ./gradlew test
|
|
41
|
+
|
|
42
|
+[Currently the gradle scripts do not generate a functioning client... we're
|
|
43
|
+ working on that still!]
|