Home

RTI Connext DDS Examples Repository

The purpose of this document is to explain the process for adding new examples to the RTI Community Examples Repository maintained in GitHub.

Cloning the repository

In this repository we are using git-submodules. This git feature allows us to include other repositories into this one without the need of having duplicated files. So in order to use the repository, please run the following command:

git clone --recurse-submodules https://github.com/rticommunity/rticonnextdds-examples.git

If you already have the repository cloned, run this instead:

git submodule update --init --recursive

Switching branches

The branch switching is also affected by the git-submodules feature. In order to properly switch to another branch with the specific branch submodules commits run:

git switch --recurse-submodules <branch>

or in git versions previous to 2.23:

git checkout --recurse-submodules <branch>

Location of the Examples Repository

The Examples Repository is located in rticommunity github. It is composed of a set of Git repositories that include examples of different features of RTI products.

The examples added to these repositories will “automatically” be posted to the examples section of the Community Portal, which can be found in the examples section of rticommunity. The Community Portal server maintains a synchronized copy of each of these repositories, but the process of adding a new examples is not fully automated and must be done by hand on the community portal as described in the following sections. You can access all of them in the sidebar. Also the previous and following topic will be available at the end of each page.