|
@@ -4,10 +4,25 @@ DMDirc
|
4
|
4
|
DMDirc is an IRC client written in Java. It's cross-platform, hugely
|
5
|
5
|
configurable, and is easily extensible with a robust plugins system.
|
6
|
6
|
|
|
7
|
+![DMDirc Screenshot](etcd/screenshot.png?raw=true)
|
|
8
|
+
|
|
9
|
+Getting DMDirc
|
|
10
|
+--------------------------------------------------------------------------------
|
|
11
|
+
|
|
12
|
+To download and run the latest stable version of DMDirc, download an installer
|
|
13
|
+or archive for your platform from
|
|
14
|
+[the releases page](https://github.com/DMDirc/DMDirc/releases).
|
|
15
|
+
|
|
16
|
+If there's not a distribution for your platform, you can download the Jar file
|
|
17
|
+instead. You will need to manually install OpenJDK 8 or newer in this case.
|
|
18
|
+
|
|
19
|
+Repositories
|
|
20
|
+--------------------------------------------------------------------------------
|
|
21
|
+
|
7
|
22
|
This repository doesn't actually contain the source for DMDirc. Instead it's
|
8
|
23
|
split over four different components, each with their own repository:
|
9
|
24
|
|
10
|
|
-* [client](https://github.com/DMDirc/client):
|
|
25
|
+* [client](https://github.com/DMDirc/DMDirc):
|
11
|
26
|
contains the main guts of the client
|
12
|
27
|
* [parser](https://github.com/DMDirc/parser):
|
13
|
28
|
an interface for parsers and a full IRC parser
|
|
@@ -24,7 +39,7 @@ together — that's what this repository is for! Each of the components mentione
|
24
|
39
|
above is included as a submodule, and there are some handy top-level build
|
25
|
40
|
scripts for bundling everything together.
|
26
|
41
|
|
27
|
|
-Getting Started
|
|
42
|
+Development
|
28
|
43
|
--------------------------------------------------------------------------------
|
29
|
44
|
|
30
|
45
|
### Prerequisites
|
|
@@ -83,7 +98,8 @@ they don't test how your change will affect DMDirc itself. It's good practice
|
83
|
98
|
to run all of the tests in the project and compile and run an actual client to
|
84
|
99
|
make sure everything actually still works!
|
85
|
100
|
|
86
|
|
-You can see an overview of open pull requests across all of the DMDirc projects [here](https://github.com/pulls?q=is%3Aopen+is%3Apr+user%3Admdirc).
|
|
101
|
+You can see an overview of open pull requests across all of the DMDirc projects
|
|
102
|
+[here](https://github.com/pulls?q=is%3Aopen+is%3Apr+user%3Admdirc).
|
87
|
103
|
|
88
|
104
|
### Continuous Integration and Code Coverage
|
89
|
105
|
|