Added missing section about example driver

urfeex · Jun 17, 2024 · 548f3b7 · 548f3b7
1 parent 8d90dc7
commit 548f3b7
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/doc/architecture.rst b/doc/architecture.rst
@@ -10,8 +10,8 @@ modules present in this library. Note that this is an incomplete view on the cla
 
 
 The core of this library is the ``UrDriver`` class which creates a
-fully functioning robot interface. For details on how to use it, please see the [Example
-driver](#example-driver) section.
+fully functioning robot interface. For details on how to use it, please see the
+:ref:`example-driver` section.
 
 The ``UrDriver``'s modules will be explained in the following.
 

diff --git a/doc/example.rst b/doc/example.rst
@@ -0,0 +1,11 @@
+.. _example-driver:
+
+Example driver
+==============
+In the ``examples`` subfolder you will find a minimal example of a running driver. It starts an
+instance of the ``UrDriver`` class and prints the RTDE values read from the controller. To run it make
+sure to
+ * have an instance of a robot controller / URSim running at the configured IP address (or adapt the
+   address to your needs)
+ * run it from the package's main folder (the one where this README.md file is stored), as for
+   simplicity reasons it doesn't use any sophisticated method to locate the required files.
diff --git a/doc/index.rst b/doc/index.rst
@@ -8,4 +8,5 @@ ur_client_library
    installation
    polyscope_compatibility
    architecture
+   example
    real_time