Added install instruction reference

This commit is contained in:
Erik C. Thauvin 2023-08-16 08:41:48 -07:00
parent 5597004f79
commit bf087f4a4d
2 changed files with 4 additions and 1 deletions

View file

@ -7,7 +7,9 @@
[![Snapshot](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/snapshots/com/uwyn/rife2/bld-generated-version/maven-metadata.xml?label=snapshot)](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-generated-version) [![Snapshot](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/snapshots/com/uwyn/rife2/bld-generated-version/maven-metadata.xml?label=snapshot)](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-generated-version)
[![GitHub CI](https://github.com/rife2/bld-generated-version/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-generated-version/actions/workflows/bld.yml) [![GitHub CI](https://github.com/rife2/bld-generated-version/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-generated-version/actions/workflows/bld.yml)
To automatically create a generated version class using the default template in your project on compile: To install, please refer to the [extensions documentation](https://github.com/rife2/bld/wiki/Extensions).
To automatically create a generated version class using the default template in your project on compile, add the following to your build file:
```java ```java
@Override @Override
public void compile() throws Exception { public void compile() throws Exception {

View file

@ -41,6 +41,7 @@ public class GeneratedVersionOperationBuild extends Project {
javadocOperation() javadocOperation()
.javadocOptions() .javadocOptions()
.docLint(NO_MISSING) .docLint(NO_MISSING)
.link("https://rife2.github.io/bld/")
.link("https://rife2.github.io/rife2/") .link("https://rife2.github.io/rife2/")
.link("https://javadoc.io/doc/net.sourceforge.pmd/pmd-core/latest/"); .link("https://javadoc.io/doc/net.sourceforge.pmd/pmd-core/latest/");