From d7a4e5fd752df2062d6f8ca7f645e15e13c17084 Mon Sep 17 00:00:00 2001
From: KiselevIlia <ilia.kiselev@tii.ae>
Date: Mon, 1 Apr 2024 17:22:07 +0400
Subject: [PATCH] How to use collision and groundtruth plugins

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/README.md b/README.md
index 97e4f5b..7772829 100644
--- a/README.md
+++ b/README.md
@@ -35,3 +35,45 @@ make
 cpack -G DEB
 sudo dpkg -i *.deb
 ```
+
+### Tips
+For the [**_collision plugin_**](./src/harmonic_collision.cpp) a model must have
+1. Collision
+```
+<collision name='collision'>
+    <geometry>
+        <box>
+            <size>2.0 1.0 0.5</size>
+        </box>
+    </geometry>
+</collision>
+```
+ 2. Contact sensor
+ ```
+<sensor name='sensor_contact' type='contact'>
+    <contact>
+        <!--The name of the collision element from above-->
+        <collision>collision</collision>
+    </contact>
+</sensor>
+ ```
+3. Plugins 
+```
+<plugin filename="gz-sim-contact-system"
+        name="gz::sim::systems::Contact">
+</plugin>
+<plugin filename="collision_plugin"
+        name="gz::CollisionPlugin">
+    <!-- 1000 == 1 sec -->
+    <updateRate>1000</updateRate>
+</plugin>
+```
+
+For the [**_groundtruth plugin_**](./src/groundtruth_plugin.cpp) a model must have only plugin
+```
+<plugin filename="groundtruth_plugin"
+    name="gz::sim::systems::GroundtruthPlugin">
+    <!-- 1000 == 1 sec -->
+    <update_frequency>100</update_frequency>
+</plugin>
+```
\ No newline at end of file