Page tree
Skip to end of metadata
Go to start of metadata

This page is an attempt at a new style of help for users. Since there is an essentially infinite set of tool combinations to use, we will supply a guide for each tool, written by an IHMC developer who uses that tool. A lot of these pages are not yet complete.

Getting Started

In general:

  1. Pick an operating system
    Ubuntu Desktop - https://www.ubuntu.com/download/desktop
    Windows - but you must apply this solution: Long Paths in Windows
    MacOS - https://www.apple.com/macos/Install all of the following:
    JDK 8u131 or higher (we do not yet support 9) - http://www.oracle.com/technetwork/java/javase/downloads/index.html
    Git -
    https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
    Gradle -
    https://gradle.org/install/
  2. Pick a graphical Git tool (optional)
    SmartGit - https://www.syntevo.net/smartgit/
  3. Use Git to create a repository-group w/ IHMC Open Robotics Software
    - In your system home folder (or C:/ drive in Windows), clone a copy of repository-group
    - Inside the repository-group folder, clone ihmc-open-robotics-software
    It should look like:
    repository-group
    ├── ihmc-open-robotics-software
    │   └── build.gradle
    │   └── gradle.properties
    │   └── settings.gradle
    ├── build.gradle
    ├── gradle.properties
    └── settings.gradle

    You may wish to clone more projects depending what you are working on. Atlas and Valkyrie simulations are included in Open Robotics Software but not their user interfaces. New employees should check out the following repositories: Default Repository Clone List

  4. Choose and install an IDE:
    1. IntelliJ - https://www.jetbrains.com/idea/download/
      1. Streamlined user experience
      2. Superior Gradle script editing
      3. Problems on Windows w/ long classpaths
    2. Eclipse - https://wiki.eclipse.org/Eclipse/Installation
      1. Faster compilation, quicker to launch simulations
      2. Fantastic multi-monitor support
      3. Really bad Gradle editor
  5. Use the IDE to import the code you cloned
    IntelliJ - https://www.jetbrains.com/help/idea/gradle.html#gradle_import
    Eclipse - https://github.com/eclipse/buildship/blob/master/docs/user/Overview.md#project-import
    Perform the Import directly on the repository-group folder or the repository-group/build.gradle file.
  6. Learn about Java/Gradle, read project READMEs
    ihmc build plugin - https://github.com/ihmcrobotics/ihmc-build/blob/master/README.md
    repository group - https://github.com/ihmcrobotics/repository-group/blob/master/README.md

Operating Systems

Getting Started with Ubuntu Desktop - Free, most compatible with robots

Getting Started with Windows

Getting Started with Mac OS X

Git Tools

Getting Started with Git (command line)

Getting Started with vcstool - Batch Git operations on groups of repos on command line

Getting Started with SmartGit - Requires license, most feature complete Git GUI

Getting Started with IntelliJ VCS Plugin - Very nice to use, can be sluggish

Getting Started with Eclipse EGit VCS Plugin - Not many features, buggy

Integrated Development Environments (IDEs)

Getting Started with IntelliJ IDEA

Getting Started with Eclipse IDE

Build Tools

Getting Started with Java

Getting Started with Gradle