robocin / vss-base-software

vss-base-software 🇧🇷 🤖⚽

Overview

• Operational System: Ubuntu 20.04 LTS or above:

  • The operating systems mentioned above were used in the development of this repository and other repositories that were used as sub-modules. Any other operating system may require different installation scripts than those provided;

• This repository contains submodules:

  • If you want to clone a repository including its submodules you can use the --recursive parameter.

git clone --recursive [URL to Git repo]

• • If you already have cloned a repository and now want to load its submodules you have to use submodule update.

git submodule update --init
# if there are nested submodules:
git submodule update --init --recursive

Dependencies

• CMake 3.15 or above;
• C++20 or above:
  • gcc ≥ 11;
  • Some small features used were merged into C++20;
• Qt Framework 6.1.0 or above:
  • Some dependencies require Qt;
  • Qt provides several libraries that facilitate the development of the interface, in addition to powerful classes, namespaces, macros and more;
• Google Protobuf;
  • Protocol buffers are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data;
• OpenGL;
• boost:
  • Boost libraries are intended to be widely useful, and usable across a broad spectrum of applications;

all required dependencies can be installed using scripts/setup.py

Building (Linux only)

• First clone into your preferred location:

cd /path/to/repository/
git clone [e-mail]:robocin/vss-base-software.git
cd vss-base-software
git submodule update --init --recursive

Create a build directory within the project (this is ignored by .gitignore):

mkdir build
cd build

Run CMake to generate the makefile:

cmake ..

Then compile the program (for a safe multithreading compilation use: -j$(grep -c ^processor /proc/cpuinfo)):

make -j$(grep -c ^processor /proc/cpuinfo)

The executable will be located on the bin directory.

2021, José Cruz