Update README (#42)

* Refs #15098: Update README Signed-off-by: jparisu <javierparis@eprosima.com> * Refs #15098: apply suggestions Signed-off-by: jparisu <javierparis@eprosima.com> * Refs #15098: apply suggestions from #40 Signed-off-by: jparisu <javierparis@eprosima.com>
eProsima · Jul 8, 2022 · a959879 · a959879
1 parent fa894ab
commit a959879
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 69 deletions.
diff --git a/README.md b/README.md
@@ -1,60 +1,36 @@
 # Fast DDS Visualizer Plugin
 
-> :warning: **TODO**
-
-## Existing Plugins
-
-- Fast DDS Visualizer Plugin DataStream.
-
-## Install from source using Colcon
-
-### Qt dependencies
-
-Download Qt dependencies for PlotJuggler:
-
-```sh
-sudo apt -y install qtbase5-dev libqt5svg5-dev libqt5websockets5-dev libqt5opengl5-dev libqt5x11extras5-dev libprotoc-dev
-```
-
-### Fast DDS dependencies
-
-Download Fast DDS dependencies as specified in the following [link](https://fast-dds.docs.eprosima.com/en/latest/installation/sources/sources_linux.html#requirements).
-It is not needed to install Fast DDS, as it will be installed within this workspace.
-
-### Download required projects
-
-Create a colcon workspace and clone the repositories:
-
-```bash
-mkdir -p ~/fastdds_visualizer_plugin/src
-cd ~/fastdds_visualizer_plugin
-wget https://raw.githubusercontent.com/eProsima/fastdds-visualizer-plugin/main/fastdds_visualizer_plugin.repos
-vcs import src < fastdds_visualizer_plugin.repos
-```
-
-### Compile using colcon
-
-```bash
-colcon build
-```
-
-## Use Fast DDS Plugin
-
-In order to use this plugin, execute the PlotJuggler application (`./install/plotjuggler/bin/plotjuggler/`).
-Once in the application, go to the menu _App -> Preferences -> Plugins_ and add the location of the library
-`fastdds_visualizer_plugin`, installed by this project in `INSTALL_PREFIX_PATH/bin`.
-In case of colcon built, the path is `./install/fastdds_visualizer_plugin/bin/`.
-
-### Dynamic Types
-
-In order to use the Fast DDS Plugin of PlotJuggler, it is necessary to use Dynamic Types.
-There are several ways to configure this:
-
-1. Configure Fast DDS entities to share the data type information. This is done by:
-    1. Have Data Type descriptor:
-        1. Use Fast DDS Gen with `-objectype` option to generate Data Type description info from `.idl` file.
-        1. Register Data Type from `.xml` file.
-    1. Configure QoS to share Data Type Information.
-        1. `auto_fill_type_information(true)`
-        1. `auto_fill_type_object(true)`
-1. Add the `.xml` file with the data types required.
+*eProsima Fast DDS Visualizer Plugin* is a plugin for the *PlotJuggler* application.
+PlotJuggler is a graphical desktop application providing visualization features
+of data series, time series, X-Y plots.
+It also adds data management features, such as
+data import and export, custom and built-in data manipulation functions,
+data series merges, etc.
+Also, this software supports many different layouts, with dynamic, rich and user-friendly customization.
+
+*Fast DDS Visualizer Plugin* allows users to visualize topic-related data from a DDS network.
+The user can select several topics from the discovered topics running in the DDS network.
+These topics will be divided by values using data type introspection,
+and each value could be visualized and managed separately, allowing the user to quickly visualize
+in different ways the detailed data content that is being
+exchanged in the network.
+
+*eProsima Fast DDS Visualizer Plugin* supports the following features:
+
+1. **Data type introspection**: by using *Fast DDS Dynamic Types*,
+   this plugin allows to discover the data type of the topic,
+    and to visualize the data content using the corresponding data type.
+1. **DDS Configurations**: Different configurations can be set to choose the *Domain Id* and to
+   select specific *DDS Topics* to be visualized.
+1. **All PlotJuggler features**: This plugin composes nicely with all the PlotJuggler features,
+   so that users can create rich graphs from sophisticated data manipulations.
+
+## Documentation
+
+You can access the documentation online, which is hosted on [Read the Docs](https://plotjuggler-fastdds-plugins.readthedocs.io/en/latest/).
+
+* [Installation Manual](https://plotjuggler-fastdds-plugins.readthedocs.io/en/latest/rst/installation/linux.html)
+* [Getting Started](https://plotjuggler-fastdds-plugins.readthedocs.io/en/latest/rst/getting_started/tutorial.html)
+* [User Manual](https://plotjuggler-fastdds-plugins.readthedocs.io/en/latest/rst/user_manual/start_plugin.html)
+* [Developer Manual](https://plotjuggler-fastdds-plugins.readthedocs.io/en/latest/rst/developer_manual/installation/sources/linux.html)
+* [Release Notes](https://plotjuggler-fastdds-plugins.readthedocs.io/en/latest/rst/notes/notes.html)
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -90,7 +90,7 @@ install(DIRECTORY ${DOCS_OUTPUT_HTML_DIR}
     PATTERN ".buildinfo" EXCLUDE)
 set(CPACK_COMPONENT_monitor-sphinx_DISPLAY_NAME "Fast DDS Visualizer Plugin Sphinx")
 set(CPACK_COMPONENT_monitor-sphinx_DESCRIPTION
-    "eProsima Fast Fast DDS Visualizer Plugin documentation in ${DOCS_BUILDER} format")
+    "eProsima Fast DDS Visualizer Plugin documentation in ${DOCS_BUILDER} format")
 set(CPACK_COMPONENTS_ALL ${CPACK_COMPONENTS_ALL} ${DOCS_BUILDER})
 
 

diff --git a/docs/rst/developer_manual/installation/sources/linux.rst b/docs/rst/developer_manual/installation/sources/linux.rst
@@ -21,7 +21,7 @@ Dependencies installation
 =========================
 
 |eplotjuggler| depends on |efastdds| library, Qt, |plotjuggler|, and certain Debian packages.
-This section describes the instructions for installing |efastdds| dependencies and requirements in a Linux
+This section describes the instructions for installing |eplotjuggler| dependencies and requirements in a Linux
 environment from sources.
 The following packages will be installed:
 
@@ -39,7 +39,7 @@ Afterwards, the user can choose whether to follow either the :ref:`colcon <colco
 Requirements
 ------------
 
-The installation of |efastdds| in a Linux environment from binaries requires the following tools to be
+The installation of |eplotjuggler| in a Linux environment from binaries requires the following tools to be
 installed in the system:
 
 * :ref:`cmake_gcc_pip_wget_git_sl`
@@ -52,7 +52,7 @@ installed in the system:
 CMake, g++, pip, wget and git
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-These packages provide the tools required to install |efastdds| and its dependencies from command line.
+These packages provide the tools required to install |eplotjuggler| and its dependencies from command line.
 Install CMake_, `g++ <https://gcc.gnu.org/>`_, pip_, wget_ and git_ using the package manager of the appropriate
 Linux distribution. For example, on Ubuntu use the command:
 
@@ -307,7 +307,7 @@ Local installation
 Global installation
 -------------------
 
-To install |efastdds| system-wide instead of locally, remove all the flags that
+To install |eplotjuggler| system-wide instead of locally, remove all the flags that
 appear in the configuration steps of :code:`Fast-CDR`, :code:`Fast-DDS`, and
 :code:`DDS-Visualizer-Plugin`, and change the first in the configuration step of :code:`foonathan_memory_vendor` to the
 following:

diff --git a/docs/rst/getting_started/tutorial.rst b/docs/rst/getting_started/tutorial.rst
@@ -26,11 +26,11 @@ Prerequisites
 First of all, you need to follow the steps outlined in the :ref:`Installation Manual <installation_manual_windows>` for
 the installation of |eplotjuggler| and all its dependencies.
 In addition, please refer to *ShapesDemo* `Installation Manual <https://eprosima-shapes-demo.readthedocs.io/en/latest/installation/windows_binaries.html>`_
-and install this application before getting started. Version ``2.7.0`` or above is required in this tutorial.
+and install this application before getting started. Version ``2.7.0`` or above is required in this tutorial
 
 Both of them, along with other *eProsima* tools and products, are preinstalled in **Fast DDS Suite**, so consider using
-:ref:`DDS Visualizer Plugin within Fast DDS Suite <dds_suite>` as it already presents all the elements required to
-follow this example.
+:ref:`PlotJuggler eProsima Edition within Fast DDS Suite <dds_suite>`
+as it already presents all the elements required to follow this example.
 It may also be useful, though not required, to have a look at *Plotjuggler*'s introductory tutorials available in this
 section :ref:`user_manual_tutorials`.
 

diff --git a/docs/rst/installation/docker.rst b/docs/rst/installation/docker.rst
@@ -7,7 +7,7 @@
 PlotJuggler eProsima Edition Docker image
 #########################################
 
-eProsima distributes a Docker image of the |ddsvisualizer| with Ubuntu 20.04 as base image.
+eProsima distributes a Docker image of |eplotjuggler| with Ubuntu 20.04 as base image.
 This image launches the |plotjuggler| application with the |ddsvisualizer| already installed and sourced.
 
 #.  This Docker image was built for Ubuntu 20.04 (Focal Fossa).

diff --git a/docs/titlepage.rst b/docs/titlepage.rst
@@ -12,12 +12,12 @@
   :target: http://www.eprosima.com/
 
 *eProsima Fast DDS Visualizer Plugin* is a plugin for the *PlotJuggler* application.
-PlotJuggler is a graphical desktop application providing visualizations features
+PlotJuggler is a graphical desktop application providing visualization features
 of data series, time series, X-Y plots.
 It also adds data management features, such as
 data import and export, custom and built-in data manipulation functions,
 data series merges, etc.
-Also, this software support many different layouts, with dynamic, rich and user-friendly customization.
+Also, this software supports many different layouts, with dynamic, rich and user-friendly customization.
 
 *Fast DDS Visualizer Plugin* allows users to visualize topic-related data from a DDS network.
 The user can select several topics from the discovered topics running in the DDS network.