|
@@ -0,0 +1,24 @@
|
|
1
|
+DMDirc plugins
|
|
2
|
+================================================================================
|
|
3
|
+
|
|
4
|
+This repository contains plugins for [DMDirc](https://www.dmdirc.com/), a Java
|
|
5
|
+IRC client.
|
|
6
|
+
|
|
7
|
+Development information
|
|
8
|
+--------------------------------------------------------------------------------
|
|
9
|
+
|
|
10
|
+### Gradle configurations
|
|
11
|
+
|
|
12
|
+We have two custom configurations for use when defining plugin dependencies:
|
|
13
|
+
|
|
14
|
+The **bundle** configuration allows dependencies to be bundled together into
|
|
15
|
+the plugin's jar file. This should be used for dependencies required at runtime
|
|
16
|
+that are not included in the main DMDirc client, or accessed via other plugins.
|
|
17
|
+Most of a plugin's dependencies should end up in the bundle configuration.
|
|
18
|
+
|
|
19
|
+The **provided** configuration works like the Maven 'provided' scope. It
|
|
20
|
+defines dependencies required to compile and run the plugin that will be
|
|
21
|
+provided to it somehow externally. Anything in the provided configuration
|
|
22
|
+(including transitive dependencies) will *not* be bundled into the plugin jar.
|
|
23
|
+The provided configuration is used for the main DMDirc client, and should be
|
|
24
|
+used for any intra-plugin dependencies.
|