Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Fully hand-held tutorial on setting up the Java environment to a usable state as quickly as possible. Only knowledge of using the terminal is expected. This tutorial will be completely self-contained (excluding links to downloads).

For more detailed tutorials, see Entry Point: Running IHMC SoftwareGeneral Development Environment Setup Guide

Table of Contents


Ubuntu

(in progress)

...

This will be used for all terminal interactions on Windows. Access by searching for Git Bash on the windows search.

Hereby, "open a terminal" will refer to launching git bash.

Java

...

We use Java 17.

This will download Java to the folder folder (or as appropriate for the version)

Code Block
C:\Program Files\Java\jdk-17.0.3.1
  • (The java path variable is already set. No action is needed)
  • Double-check that java is installed properly:

Open a terminal and type in:

Code Block
java -version

Something like the following should be outputted:

Code Block
java version "17.0.3.1" 2022-04-22 LTS
Java(TM) SE Runtime Environment (build 17.0.3.1
  •  Add the above path to your environmental variables: // TODO is this step necessary anymore?

Open windows search and search for "Environmental Variables"

Image Removed

...

+2-LTS-6)
Java HotSpot(TM) 64-Bit Server VM (build 17.0.3.1+2-LTS-6, mixed mode, sharing)

Gradle

We are currently on Gradle 7. We will install it manually for ease of understanding. The official guide is here for reference. (Aside: we do not use the Gradle Wrapper)

  • Download the latest Gradle 7 distribution (7.4.2 as of writing).
    • Choose the complete version.
    • Remember where you downloaded it.
  • Unpack Gradle (excerpted from the gradle website)

    Excerpt

    Create a new directory C:\Gradle with File Explorer.

    Open a second File Explorer window and go to the directory where the Gradle distribution was downloaded. Double-click the ZIP archive to expose the content. Drag the content folder gradle-7.4.2 to your newly created C:\Gradle folder.

  • Configure Gradle

    Excerpt

    In File Explorer right-click on the This PC (or Computer) icon, then click Properties -> Advanced System Settings -> Environmental Variables.

    Under System Variables select Path, then click Edit. Add an entry for C:\Gradle\gradle-7.4.2\bin. Click OK to save.

  • Verify installation

    Excerpt

    Open a console (or a Windows command prompt) and run gradle -v to run gradle and display the version, e.g.:

    Code Block
    $ gradle -v
    
    ------------------------------------------------------------
    Gradle 7.4.2
    ------------------------------------------------------------

IDE