Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
timmolter committed Jan 5, 2024
1 parent b453fa3 commit d0addef
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -572,14 +572,17 @@ libraryDependencies += "org.knowm.xchart" % "xchart" % "3.8.6" exclude("de.erich

## Building with Maven

#### general
Instruction | Command
--------------------------------- | ------------------------
run unit tests | `mvn clean test`
package jar | `mvn clean package`
install in local Maven repo | `mvn clean install`
create project javadocs | `mvn javadoc:aggregate`
generate dependency tree | `mvn dependency:tree`
check for dependency updates | `mvn versions:display-dependency-updates`
check for plugin updates | `mvn versions:display-plugin-updates`
code format | `mvn com.spotify.fmt:fmt-maven-plugin:format`

mvn clean package
mvn javadoc:aggregate

#### Formatting

mvn com.spotify.fmt:fmt-maven-plugin:format

Formats your code using [google-java-format](https://github.com/google/google-java-format) which follows [Google's code styleguide](https://google.github.io/styleguide/javaguide.html).

Expand Down

0 comments on commit d0addef

Please sign in to comment.