Getting started guide

This guide will help you get your system set up and configured to run ADORe.

First review the System Requirements 🔗.
Next review the Prerequisites 🔗

Cloning the ADORe repository¶

ℹ️INFO: By default this guide assumes you have ssh keys configured for GitHub your GitHub account. For help on configuring your ssh keys visit: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account

git clone git@github.com:eclipse-adore/adore.git
cd adore
git submodule update --init --recursive

⚠️ WARNING: Failing to update and recursively clone the submodules will result in build failures!

ℹ️INFO: If you would rather clone ADORe anonymously over https please review the Anonymous Cloning 🔗 guide.

Building ADORe Developer Environment¶

⚠️ WARNING: To use the ADORe developer environment you must have Docker installed.

To have the easiest entry you can install just

and run:

1	`just dev`

Alternatively, simple call

1	`.docker/scripts/run_dev.sh`

This will create and the developer environment where you can build all relevant packages with

1	`just build`

The full command list is available with

1	`just help`

⚠️ WARNING: Building ADORe will fail until all submodules have been properly initialized. If cloning or repository initialization fails refer to the troubleshooting guide before proceeding. Do not proceed with building ADORe until git submodule update --init --receive finishes without error.

Next proceed to Running Your First Scenario 🔗

Using in an existing ROS2 project¶

The ADORe packages adore_(libraries/ros2_conversions/ros2_msgs/ros2_nodes/scenarios) can all be used directly in your existing ros2 project by pasting or symlining them into you ros2/colcon workspace.