Document jlink install

This commit is contained in:
Andres Almiray
2021-05-02 22:43:15 +02:00
parent ac654b77c5
commit f5b902231d
2 changed files with 18 additions and 3 deletions

View File

@@ -27,13 +27,17 @@ jbang jreleaser@jreleaser <command> [<args>]
.early-access
----
// Download, cache, and run
jbang jreleaser_snapshot@jreleaser <command> [<args>]
jbang jreleaser-snapshot@jreleaser <command> [<args>]
----
*manually*
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases[releases page],
uncompress and copy to the desired location.
NOTE: Be mindful that `jreleaser-{jreleaser-version}.zip` requires Java 8 to be installed while
`jreleaser-standalone-{jreleaser-version}-windows.zip` can be used without a previous installation of Java as
it includes its own Java Runtime.
--
Linux::
+
@@ -55,13 +59,17 @@ jbang jreleaser@jreleaser <command> [<args>]
.early-access
----
// Download, cache, and run
jbang jreleaser_snapshot@jreleaser <command> [<args>]
jbang jreleaser-snapshot@jreleaser <command> [<args>]
----
*manually*
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases[releases page],
uncompress and copy to the desired location.
NOTE: Be mindful that `jreleaser-{jreleaser-version}.zip` requires Java 8 to be installed while
`jreleaser-standalone-{jreleaser-version}-linux.zip` can be used without a previous installation of Java as
it includes its own Java Runtime.
--
Mac::
+
@@ -89,13 +97,17 @@ jbang jreleaser@jreleaser <command> [<args>]
.early-access
----
// Download, cache, and run
jbang jreleaser_snapshot@jreleaser <command> [<args>]
jbang jreleaser-snapshot@jreleaser <command> [<args>]
----
*manually*
Download the pre-compiled binary from the link:https://github.com/jreleaser/jreleaser/releases[releases page],
uncompress and copy to the desired location.
NOTE: Be mindful that `jreleaser-{jreleaser-version}.zip` requires Java 8 to be installed while
`jreleaser-standalone-{jreleaser-version}-osx.zip` can be used without a previous installation of Java as
it includes its own Java Runtime.
--
====
@@ -113,6 +125,8 @@ NOTE: The `--basedir` argument will be automatically set to `--basedir=/workspac
You may also need to map environment variables to the container, such as `JRELEASER_PROJECT_VERSION`,
`JRELEASER_GITHUB_TOKEN`, or others depending on your setup. Refer to the xref:configuration:index.adoc[] pages.
You can find the tag listing link:hub.docker.com/r/jreleaser/jreleaser-slim/tags[here].
== Maven
Configure the xref:tools:jreleaser-maven.adoc[jreleaser-maven-plugin] in your POM file

View File

@@ -22,3 +22,4 @@ NOTE: The `--basedir` argument will be automatically set to `--basedir=/workspac
You may also need to map environment variables to the container, such as `JRELEASER_PROJECT_VERSION`,
`JRELEASER_GITHUB_TOKEN`, or others depending on your setup.
You can find the tag listing link:hub.docker.com/r/jreleaser/jreleaser-slim/tags[here].