Add info on creating a Jar of sources.

cdk · Nov 28, 2014 · 1161464 · 1161464
1 parent bf4c200
commit 1161464
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ cdk/$ mvn compile
 
 This will produce a 'jar' file for each module located in each modules 'target/' directory.
 
-## Creating the JavaDoc documentation for the API
+## Creating the JavaDoc
 
 The JavaDoc documentation for the API describes all of the CDK classes in detail. It functions as
 the user manual for the CDK, although you should also look at the list of examples and tutorials
@@ -56,6 +56,16 @@ the documentation using the following command:
 cdk/$ firefox target/site/apidocs/index.html
 ```
 
+## Creating a Jar of all sources
+
+To create a Jar containing all source files use the following command on the main pom. 
+
+```bash
+$ mvn source:aggregate
+```
+
+The `cdk-{version}-sources.jar` will be generated in the `target/directory`.
+
 ## Running tests
 
 IMPORTANT: this requires the Git version of the sources, because the test files are not included in