Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
johnmay committed Jun 21, 2015
1 parent fc07d45 commit 58a4e74
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Expand Up @@ -41,7 +41,16 @@ This will produce a 'jar' file for each module located in each modules 'target/'
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
below.
This documentation is created by 'mvn' from the Java source code for the CDK as follows:

Before creating the JavaDoc you will need to install the CDK build util project in your local maven repo.

```bash
git clone https://github.com/cdk/cdk-build-util
cd cdk-build-util
mvn install
```

The documentation on the main project can then be created:

```bash
cdk/$ ls pom.xml
Expand Down

1 comment on commit 58a4e74

@egonw
Copy link
Member

@egonw egonw commented on 58a4e74 Jun 21, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Thanks!

Please sign in to comment.