robocomp

(β˜… 130)

RoboComp is a cutting-edge open-source robotics framework providing tools to easily create, modify and manage robot software components.

  • .gitignore
  • .gitmodules
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • LICENSE
  • README.md
  • robocomp.repos
  • robocomp_install.sh
  • STYLE_GUIDE.md

# Installation Guide

1. Get the code
git clone https://github.com/robocomp/robocomp

Downloads the entire project code from GitHub to your computer.

cd robocomp

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
  • Python 3 Python is required to use pip.
sudo apt install yakuake qt6-tools-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo apt install python3 python3-pip cmake vim git wget libopenscenegraph-dev libgsl-dev qt6-base-dev qt6-declarative-dev qt6-scxml-dev libqt6statemachineqml6 libqt6statemachine6 libbz2-dev libssl-dev zeroc-icebox zeroc-ice-all-dev libzeroc-icestorm3.7 libeigen3-dev meld

Installs directly from the APT package repository (Debian/Ubuntu-based).

pip install vcstool PySide6 zeroc-ice

Installs the package published on PyPI directly β€” no need to clone the source.

sudo apt-get install yakuake

Installs directly from the APT package repository (Debian/Ubuntu-based).

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker/docker-compose.yaml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
sudo apt install python3 python3-pip cmake vim git wget libopenscenegraph-dev libgsl-dev qt6-base-dev qt6-declarative-dev qt6-scxml-dev libqt6statemachineqml6 libqt6statemachine6 libbz2-dev libssl-dev zeroc-icebox zeroc-ice-all-dev libzeroc-icestorm3.7 libeigen3-dev meld

Installs directly from the APT package repository (Debian/Ubuntu-based).

cd ~/software/tomlplusplus && cmake -B build && sudo make install -C build -j12 && cd -

Moves into the project folder you just downloaded.

ln -s core/cmake cmake

Type this command into your terminal and run it.

echo "alias cbuild='cmake -B build && make -C build -j$(nproc)'" >> ~/.bashrc

Type this command into your terminal and run it.

cd ~/software/cppitertools && cmake -B build && sudo make install -C build -j$JOBS && cd -

Moves into the project folder you just downloaded.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

Pulled directly from this repo's README.

// repository documentation