Add a oneline description

ros-controls · Apr 9, 2024 · da003bf · da003bf
1 parent 768172e
commit da003bf
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,7 @@ realtime_tools
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 [![codecov](https://codecov.io/gh/ros-controls/realtime_tools/branch/master/graph/badge.svg?token=Osge1FOaAh)](https://app.codecov.io/gh/ros-controls/realtime_tools/tree/master)
 
+Contains a set of tools that can be used from a hard realtime thread, without breaking the realtime behavior.
 
 ## Build status
 ROS2 Distro | Branch | Build status | Documentation | Released packages

diff --git a/doc/index.rst b/doc/index.rst
@@ -1,11 +1,7 @@
 Welcome to the documentation for realtime_tools
 ===============================================
 
-.. toctree::
-   :maxdepth: 2
-
-   C++ API <generated/index>
-
+.. include:: main.rst
 
 Indices and Search
 ==================

diff --git a/doc/main.rst b/doc/main.rst
@@ -0,0 +1,6 @@
+Contains a set of tools that can be used from a hard realtime thread, without breaking the realtime behavior.
+
+.. toctree::
+   :maxdepth: 2
+
+   C++ API <generated/index>