From bf087f4a4de8cb5ab4601d6f8b597b9784680e54 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Wed, 16 Aug 2023 08:41:48 -0700 Subject: [PATCH] Added install instruction reference --- README.md | 4 +++- .../rife/bld/extension/GeneratedVersionOperationBuild.java | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6008c0c..178710f 100755 --- a/README.md +++ b/README.md @@ -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) [![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 @Override public void compile() throws Exception { diff --git a/src/bld/java/rife/bld/extension/GeneratedVersionOperationBuild.java b/src/bld/java/rife/bld/extension/GeneratedVersionOperationBuild.java index 163fa83..635662d 100644 --- a/src/bld/java/rife/bld/extension/GeneratedVersionOperationBuild.java +++ b/src/bld/java/rife/bld/extension/GeneratedVersionOperationBuild.java @@ -41,6 +41,7 @@ public class GeneratedVersionOperationBuild extends Project { javadocOperation() .javadocOptions() .docLint(NO_MISSING) + .link("https://rife2.github.io/bld/") .link("https://rife2.github.io/rife2/") .link("https://javadoc.io/doc/net.sourceforge.pmd/pmd-core/latest/");