Fix README for doc generation

Resolves #199
This commit is contained in:
Gary Russell
2019-03-11 13:35:57 -04:00
committed by Oleg Zhurakousky
parent 744c809fee
commit c1d6507957
2 changed files with 23 additions and 3 deletions

View File

@@ -40,7 +40,11 @@ in Docker containers.
=== Documentation
There is a "full" profile that will generate documentation.
There is a "docs" profile that will generate documentation.
`./mvnw clean package -Pdocs -DskipTests`
The reference documentation can then be found in `docs/target/contents/reference`.
=== Working with the code
If you don't have an IDE preference we would recommend that you use