Skip to content

Commit

Permalink
Add links to binaries to getting started guide
Browse files Browse the repository at this point in the history
  • Loading branch information
atextor committed Mar 31, 2021
1 parent 1152062 commit 4c5a1dc
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 9 deletions.
1 change: 1 addition & 0 deletions docs/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: owl-cli
version: snapshot
asciidoc:
attributes:
release-version: snapshot
page-component-version: snapshot
nav:
- modules/ROOT/nav.adoc
Expand Down
37 changes: 28 additions & 9 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,44 @@ image::splash.svg[width=75%]

Things you will need to have installed to run *owl-cli*:

* Java (OpenJDK) *11* or newer
* https://www.graphviz.org/[Graphviz] for the generation of diagrams. Note that this is a common
package that can be installed via all popular package managers, for example `apt-get`, `brew` or
`rpm`.
* https://www.graphviz.org/[Graphviz] for the generation of diagrams.
** Install in Windows (using https://chocolatey.org/[Chocolatey]): `choco install graphviz`
** Install in MacOs (using https://brew.sh/[Brew]): `brew install graphviz`
** Install in Ubuntu/Debian Linux: `apt install graphviz`

=== Download and install
* If using the executable .jar file: Java (OpenJDK) *11* or newer

Open your favorite terminal emulator and execute the following commands:
=== Download and Install `owl-cli`

Download the pre-built binary for your platform:

* Windows (x86_64): https://github.com/atextor/owl-cli/releases/download/{release-version}/owl-x86_64-windows-{release-version}.exe[owl-x86_64-windows-{release-version}.exe]
* MacOs (x86_64): https://github.com/atextor/owl-cli/releases/download/{release-version}/owl-x86_64-apple-darwin-{release-version}[owl-x86_64-apple-darwin-{release-version}]
* Linux (x86_64): https://github.com/atextor/owl-cli/releases/download/{release-version}/owl-x86_64-linux-{release-version}[owl-x86_64-linux-{release-version}]
* Other platforms or architectures: Please use the executable .jar file: https://github.com/atextor/owl-cli/releases/download/{release-version}/owl-cli-{release-version}.jar[owl-cli-{release-version}.jar]

Rename the binary to `owl.exe` (Windows) or `owl` (MacOs/Linux), put it in your favorite directory
and add this directory to the PATH environment variable:

* Windows: `setx /M path "%path%;C:\your\path\here\"`
* MacOs/Linux: `echo 'export PATH=/your/path/here:$PATH' >> ~/.bashrc; source ~/.bashrc`

[NOTE]
====
If using the executable .jar file, the following commands will make the jar available as `owl`
command as well. This works in MacOs and Linux.
[source,shell]
----
curl -L -o ~/.local/share/owl-cli/owl-cli.jar --create-dirs https://github.com/atextor/owl-cli/releases/download/snapshot/owl-cli.jar
echo 'function owl() { java -jar ~/.local/share/owl-cli/owl-cli.jar $*; }' >> ~/.bashrc
source ~/.bashrc
----
====

After installation, you can use the `owl` command: See xref:usage.adoc[] for more information.

== Building from source
== Building from Source

[[building-executable-jar]]
=== Building the executable JAR from source
Expand Down Expand Up @@ -102,8 +121,8 @@ source $HOME/.sdkman/bin/sdkman-init.sh
# Use SDKMAN! to install JDKs
sdk install java 15.0.2-open
sdk install java 20.1.0.r11-grl
sdk use java 20.1.0.r11-grl
sdk install java 21.0.0.2.r11-grl
sdk use java 21.0.0.2.r11-grl
# Build the project
git clone https://github.com/atextor/owl-cli.git
Expand Down
1 change: 1 addition & 0 deletions scripts/do-release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ git add docs/modules/ROOT/assets/images/*.svg
# Set versions
sed -i -e 's/version: snapshot/version: '$version'/g' docs/antora.yml
sed -i -e 's/page-component-version: snapshot/page-component-version: '$tag'/g' docs/antora.yml
sed -i -e 's/release-version: snapshot/release-version: '$version'/g' docs/antora.yml
sed -i -e 's/snapshot/'$version'/g' gradle.properties
git add docs/antora.yml
git add gradle.properties
Expand Down

0 comments on commit 4c5a1dc

Please sign in to comment.