Skip to content

Commit

Permalink
Documentation updates [5372] (eProsima#519)
Browse files Browse the repository at this point in the history
* Refs eProsima#5335 Homogenization of Fast-RTPS and Fast-RTPS-docs README files

* Refs eProsima#5335 Fixing link to release notes

* Refs eProsima#5335 Removing old release notes

* Refs eProsima#5335 Updates to roadmap

* Refs eProsima#5335 Addressing review comments
  • Loading branch information
raquelalvarezbanos authored and MiguelCompany committed May 13, 2019
1 parent cb44b6b commit d3dc620
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 11 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[![Stars](https://img.shields.io/github/stars/eProsima/Fast-RTPS.svg)](https://github.com/eProsima/Fast-RTPS/stargazers)

<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>

*eprosima Fast RTPS* is a C++ implementation of 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
Service (DDS) standard, again by the OMG. *eProsima Fast RTPS* holds the benefit of being standalone and up-to-date, as most vendor solutions either implement RTPS as a tool to implement
Expand All @@ -24,7 +25,7 @@ network.
system input/output channel combination for each deployment.
* Two API Layers: a high-level Publisher-Subscriber one focused on usability and a lower-level Writer-Reader one that provides finer access to the inner workings of the RTPS protocol.

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

* Robotics: ROS (Robotic Operating System) as their default middleware for ROS2.
* EU R&D: FIWARE Incubated GE.
Expand Down Expand Up @@ -52,13 +53,13 @@ Clone the project from GitHub:

If you are on Linux, execute:

$ cmake -DTHIRDPARTY=ON ..
$ cmake ../ -DTHIRDPARTY=ON
$ make
$ make install

If you are on Windows, choose your version of Visual Studio:

> cmake -G "Visual Studio 14 2015 Win64" -DTHIRDPARTY=ON ..
> cmake ../ -G "Visual Studio 14 2015 Win64" -DTHIRDPARTY=ON
> cmake --build . --target install

If you want to compile the performance tests, you will need to add the argument `-DPERFORMANCE_TESTS=ON` when calling Cmake.
Expand All @@ -71,7 +72,7 @@ You can access the documentation online, which is hosted on [Read the Docs](http
* [Installation manual](http://eprosima-fast-rtps.readthedocs.io/en/latest/requirements.html)
* [User manual](http://eprosima-fast-rtps.readthedocs.io/en/latest/introduction.html)
* [FastRTPSGen manual](http://eprosima-fast-rtps.readthedocs.io/en/latest/geninfo.html)
* [Release notes](http://eprosima-fast-rtps.readthedocs.io/notes.html)
* [Release notes](http://eprosima-fast-rtps.readthedocs.io/en/latest/notes.html)

## Getting Help

Expand Down
4 changes: 0 additions & 4 deletions ReleaseNotes.txt

This file was deleted.

6 changes: 3 additions & 3 deletions roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ If you would like to learn about the overall Roadmap of FIWARE, please check sec
## Introduction

This section elaborates on proposed new features or tasks which are expected to be added to the product in the
oreseeable future.
foreseeable future.
There should be no assumption of a commitment to deliver these features on specific dates or in the order given.
The development team will be doing their best to follow the proposed dates and priorities, but please bear in mind
that plans to work on a given feature or task may be revised.
Expand All @@ -15,7 +15,7 @@ at any time.

Disclaimer:

* This section has been last updated in February 2019.
* This section has been last updated in May 2019.
Please take into account its content could be obsolete.

## Short term
Expand All @@ -24,13 +24,13 @@ The following list of features are planned to be addressed in the short term, an
release(s) of the product:

* QNX Support.
* Liveliness QoS

## Medium term

The following list of features are planned to be addressed in the medium term, typically within the subsequent
release(s) generated in the next **9 months** after next planned release:

* Deadline QoS
* Realtime support: Decrease dynamic memory allocations

## Long term
Expand Down

0 comments on commit d3dc620

Please sign in to comment.