Skip to content

Update Readme #1294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zesk1999 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Readme #1294

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<a href="https://github.com/eProsima/Fast-DDS-docs/actions/workflows/nightly-ubuntu-ci.yml"><img alt="Fast DDS docs Ubuntu" src="https://github.com/eProsima/Fast-DDS-docs/actions/workflows/nightly-ubuntu-ci.yml/badge.svg"/></a>
</div>

<a href="http://www.eprosima.com"><img src="https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcSd0PDlVz1U_7MgdTe0FRIWD0Jc9_YH-gGi0ZpLkr-qgCI6ZEoJZ5GBqQ" align="left" hspace="8" vspace="2" width="100" height="100" ></a>
<a href="http://www.eprosima.com"><img src="docs/_static/eprosima-logo.svg" align="left" hspace="8" vspace="2" width="100" height="100" ></a>

*eprosima Fast DDS* (formerly Fast RTPS) is a C++ implementation of the DDS (Data Distribution Service) standard of the OMG (Object Management Group). eProsima Fast DDS implements the RTPS (Real Time Publish Subscribe) protocol, which provides publisher-subscriber communications over unreliable transports such as UDP,
as defined and maintained by the Object Management Group (OMG) consortium. RTPS is also the wire interoperability protocol defined for the Data Distribution
Expand Down Expand Up @@ -34,7 +34,7 @@ system input/output channel combination for each deployment.

*eProsima Fast DDS* has been adopted by multiple organizations in many sectors including these important cases:

* Robotics: ROS (Robotic Operating System) as their default middleware for ROS2.
* Robotics: ROS (Robot Operating System) as their default middleware for ROS 2.
* EU R&D: FIWARE Incubated GE.

You can find all the library's source code on our [GitHub repository](https://github.com/eProsima/Fast-DDS).
Expand All @@ -49,7 +49,7 @@ The online documentation generated with this project can be found in [Fast DDS d
## Installation Guide

The following guide has been developed and tested in Ubuntu 20.04.
It covers two mechanisms for build and testing the documentation (colcon and CMake), and one that just generates the HTML, which can be used to simulate the process followed in ReadTheDocs.
It covers two mechanisms for building and testing the documentation (colcon and CMake), and one that just generates the HTML, which can be used to simulate the process followed in ReadTheDocs.
Contributors are asked to not only generate the HTML, but to also build and test their changes locally following one of the two first methods.

1. [Install common dependencies](#install-common-dependencies)
Expand Down Expand Up @@ -187,7 +187,7 @@ When this variable is set to `True`, [conf.py](docs/conf.py) will clone Fast DDS
1. If the variable is not set, or the branch does not exist, try to checkout to a branch with the same name as the current branch on this repository.
1. If the previous fails, fallback to `master`.

Also Fast DDS Python bindings is cloned and follows a similar criteria:
Also, Fast DDS Python bindings are cloned and follow a similar criteria:

1. Try to checkout to the branch specified by environment variable `FASTDDS_PYTHON_BRANCH`.
1. If the variable is not set, or the branch does not exist, try to checkout to a branch with the same name as the current branch on this repository.
Expand All @@ -211,7 +211,7 @@ READTHEDOCS=True FASTDDS_BRANCH=<branch> FASTDDS_PYTHON_BRANCH=<branch> sphinx-b

Using either CMake or colcon, the documentation is built using Sphinx's `html` builder.
However, Sphinx supports several other building formats, which are enabled through [Sphinx builders](https://www.sphinx-doc.org/en/master/usage/builders/index.html).
Once a builder is selected, the documentation can be built using the [Simulating Read the Docs](#simulating-read-the-docs) approach, specifying the appropriate builder with the `-b` CLI option
Once a builder is selected, the documentation can be built using the [Simulating Read the Docs](#simulating-read-the-docs) approach, specifying the appropriate builder with the `-b` CLI option.

### Auditing API reference wrappers

Expand All @@ -238,7 +238,7 @@ The project is structured as follows:
1. The [docs directory](#docs-directory) contains all documentation source code.
1. Code snippets and testing code is located in the [code directory](#code-directory).

### `doc` directory
### `docs` directory

The [docs](docs) directory contains:

Expand Down