Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update FiveMinuteIntro: Java 11 requirement #6830

Merged
merged 4 commits into from
Feb 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/Releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ You are strongly encouraged to use the latest release of Cromwell whenever possi
Cromwell is distributed as a conda package on [conda-forge](https://conda-forge.org/).
These instructions need to be followed for [installing the miniconda distribution](https://docs.conda.io/en/latest/miniconda.html) and
[activating the conda-forge channel](https://conda-forge.org/#about). After this Cromwell can be installed in the
base environment with `conda install cromwell` or a separate environment for Cromwell can be created with
`conda create -n cromwell cromwell`. If you are using Cromwell for bioinformatics workflows, you might like to take
base environment with `conda install -c conda-forge cromwell` or a separate environment for Cromwell can be created with
`conda create -n cromwell cromwell` (be sure to activate the conda-forge channel first).
If you are using Cromwell for bioinformatics workflows, you might like to take
a look at [bioconda](http://bioconda.github.io) as well.
The conda installation of Cromwell comes with a wrapper that locates the jar for you and allows for running Cromwell or Womtool with a
`cromwell run`, `womtool validate` or other command. Conda also installs the required Java dependency
Expand Down
8 changes: 5 additions & 3 deletions docs/tutorials/FiveMinuteIntro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@

* A Unix-based operating system (yes, that includes Mac!)
* A Java 11 runtime environment
* You can see what you have by running `$ java -version` on a terminal.
* If not, you can download Java [here](https://adoptopenjdk.net/).
* You might need to update the `export JAVA_HOME` in your bash profile to point to your JAVA install location.
* You can see what you have by running `$ java -version` on a terminal.
* If not, consider installing via conda or brew [as explained here](../Releases.md).
* We recommend [SDKMAN](https://sdkman.io/install) to install the latest 11 build of [Temurin](https://adoptium.net/temurin/releases/?version=11)
* `sdk install java 11.0.16-tem` as of the time of this writing
* You might need to update the `export JAVA_HOME` in your bash profile to point to your JAVA install location.
* A sense of adventure!

### Goals
Expand Down