Skip to content

Commit

Permalink
Merge pull request #134 from cdd/readme-fixes
Browse files Browse the repository at this point in the history
Readme typo fixes and consistent command examples.
  • Loading branch information
johnmay committed Jun 9, 2015
2 parents be3a339 + f5de611 commit 1ba0333
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Compiling the library is performed with Apache Maven and requires Java 1.7 or la

```bash
cdk/$ ls pom.xml
cdk/$ pom.xml
pom.xml
cdk/$ mvn compile
```

Expand Down Expand Up @@ -61,7 +61,7 @@ cdk/$ firefox target/site/apidocs/index.html
To create a Jar containing all source files use the following command on the main pom.

```bash
$ mvn source:aggregate
cdk/$ mvn source:aggregate
```

The `cdk-{version}-sources.jar` will be generated in the `target/directory`.
Expand Down Expand Up @@ -89,7 +89,7 @@ cdk/$ cd descriptor/fingerprint
cdk/descriptor/fingerprint/$ mvn test
```

Tutorials on building the project in integrated development enviroments (IDEs) are avaialble on the wiki:
Tutorials on building the project in integrated development environments (IDEs) are available on the wiki:
https://github.com/cdk/cdk/wiki/Building-CDK

## Using CDK
Expand All @@ -107,8 +107,10 @@ A large bundled jar with all dependencies can also be built. If you have locally
made modifications to the source code you will need to install these to your
local repository. The jar will in the target directory of the 'bundle' module.

```bash
cdk/$ mvn install -DskipTests=true
cdk/$ ls bundle/target/cdk-{version}.jar
```

If you have not made any changes you need only package the bundle module. The other
modules will be automatically downloaded.
Expand Down

0 comments on commit 1ba0333

Please sign in to comment.