README.md

Table of Contents

1. Prerequisites
2. Installation
3. Usage
4. Troubleshooting

Prerequisites

Install Docker and Docker Compose

https://docs.docker.com/engine/install/
https://docs.docker.com/compose/install/

Generate the SSH keys and store it in your account

https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account

Installation

Clone the entire workspace

git clone --recursive [email protected]:ufrj-nautilus/harpia_ws.git

Usage

Start the container

cd harpia_ws
xhost +local:docker
docker-compose up -d; docker attach harpia_ws

Update the workspace

git submodule update

Troubleshooting

Slow performance on gazebo with a NVIDIA card

Add this code block in docker-compose.yml below the image tag

deploy:
    resources:
        reservations:
            devices:
                - driver: nvidia
                  capabilities: [gpu]

Add the docker-compose.yml in the .gitignore

echo "docker-compose.yml" >> .gitignore