From 8eb001d34268d08c37ff8c014719ffa1661ad395 Mon Sep 17 00:00:00 2001
From: M0stafaRady <mostafa.rady@efabless.com>
Date: Thu, 10 Aug 2023 11:24:24 +0300
Subject: [PATCH] Add cocotb quickrun documentation to the correct rst file

---
 docs/source/index.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 3927e79d0..99339d8b7 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -148,6 +148,23 @@ Starting your project
             # for example
             make verify-io_ports-rtl
 
+#.  Run cocotb simulation on your design
+
+    *   You need to include your rtl/gl/gl+sdf files in ``verilog/includes/includes.<rtl/gl/gl+sdf>.caravel_user_project``
+
+    * To make sure the cocotb flow works, run the following commands for testing the counter example
+
+        .. code:: bash
+
+            # RTL tests
+            make cocotb-verify-rtl
+
+            # OR GL simulation using
+            make cocotb-verify-gl
+    * To run cocotb tests on your design, Follow the steps below
+        * Add cocotb tests under ``verilog/dv/cocotb`` follow steps at `Adding_cocotb_test <https://caravel-sim-infrastructure.readthedocs.io/en/latest/usage.html#adding-a-test>`_
+        * Run cocotb tests using ``caravel_cocotb`` command steps at `Running_cocotb_tests <https://caravel-sim-infrastructure.readthedocs.io/en/latest/usage.html#running-a-test>`_
+
 #.  Run opensta on your design
 
     *   Extract spefs for ``user_project_wrapper`` and macros inside it: