Skip to content
This repository has been archived by the owner on Jan 31, 2024. It is now read-only.

Latest commit

 

History

History
126 lines (86 loc) · 4.56 KB

README.md

File metadata and controls

126 lines (86 loc) · 4.56 KB
Raw

Lint and Formatting Checker Ubuntu C++ CMake License: MIT

RobôCIn Protocols 📦

The RobôCIn Protocols repository is a central hub dedicated to storing and managing protocols that are intended to be shared across multiple projects. It serves as a reliable source of the latest versions of the protocols definitions, providing an organized directory structure that categorizes and documents each protobuf file, making it simple for developers to navigate and understand the available data structures.

By centralizing protocols in a dedicated repository, the RobôCIn team promotes code reuse, modularity, and efficient development practices. Any updates or modifications to the shared protocols can be made in a controlled manner, ensuring compatibility across multiple repositories that depend on these protocols.

Table of Contents

About

The protocols contained in this repository are Protocol Buffers (protobuf).

Protobufs

Protobufs are a language-agnostic data serialization format developed by Google, which allow for efficient and structured communication between different software components. By maintaining a separate repository solely for protobufs, the RobôCIn team ensures consistency, version control, and easy access to shared data structures across various projects within the organization.

Protocol Buffers offer numerous advantages, such as efficient serialization, platform independence, and language interoperability. By using Protocol Buffers, you can easily serialize, deserialize, and exchange structured data between different systems or languages.

To work with the protocols in this repository, you will need to have Protocol Buffers installed in your development environment. You can visit the Protocol Buffers GitHub repository for installation instructions specific to your programming language.

Installation

Note: If you intend to utilize this repository on an alternative operating system, please don't hesitate to raise an issue. We are committed to providing support by helping you modify the installation process to suit your specific OS requirements.

C++

Requirements

  • CMake 3.16 or above;
  • C++20 or above:
    • gcc ≥ 11;
    • Some small features used were merged into C++20;
  • Google Protobuf;
    • Protocol Buffers compiler (protoc) and the C++ Protocol Buffers runtime library (libprotobuf).

Steps

To install the project in C++, follow these steps:

  1. Clone the repository:

    git clone https://github.com/robocin/protocols.git

  2. Navigate to the project directory:

    cd protocols

  3. Create a build directory and navigate into it:

    mkdir build
cd build

  4. Configure the project using CMake:

    cmake .. -DCMAKE_INSTALL_PREFIX=/opt/robocin_pb

    This will generate the necessary build files based on the CMakeLists.txt file present in the repository. We recommend installing the project in the /opt/robocin_pb to avoid any conflicts with other projects.

  5. Build and install the project:

    make -j $(nproc)
sudo make install -j $(nproc)

    This command will install the project, placing the necessary files in the appropriate locations.

Codemap

  • pb: Contains the protobuf definitions for the RobôCIn Protocols.

License

This project is licensed under the MIT License - see the LICENSE file for details.