Merge branch 'cocotb' of github.com:efabless/caravel into cocotb

verilog/dv/cocotb/README.md

@@ -13,6 +13,13 @@ Prerequisites
 - Docker: [Linux](https://hub.docker.com/search?q=&type=edition&offering=community&operating_system=linux&utm_source=docker&utm_medium=webreferral&utm_campaign=dd-smartbutton&utm_location=header) ||  [Windows](https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe?utm_source=docker&utm_medium=webreferral&utm_campaign=dd-smartbutton&utm_location=header) || [Mac with Intel Chip](https://desktop.docker.com/mac/main/amd64/Docker.dmg?utm_source=docker&utm_medium=webreferral&utm_campaign=dd-smartbutton&utm_location=header) || [Mac with M1 Chip](https://desktop.docker.com/mac/main/arm64/Docker.dmg?utm_source=docker&utm_medium=webreferral&utm_campaign=dd-smartbutton&utm_location=header)
 - Python 3.6+ with PIP
 - cocotb 
+```
+  apt update && apt install python3 python3-pip
+  pip3 install cocotb
+  pip3 install cocotb_coverage
+  pip3 install coverage
+  pip3 install cocotb-bus
+```
 - iverilog or vcs 
 
 run a test  
@@ -52,3 +59,31 @@ Tests
 
 Refer to [tests.json](tests.json) for tests list
 
+Directories names fixed for now
+===============
+>repo
+>>caravel_mgmt_soc_litex/
+
+>>caravel
+>>>verilog
+>>>>dv
+>>>>cocotb
+
+cocotb directory tree
+===============
+```
+├── caravel.py -> contains driving and mentoring functions for caravel interface
+├── caravel_top.sv -> testbench top level 
+├── cpu.py -> contains driving and mentoring functions for wishbone when disable the cpu 
+├── hex_files -> folder that contains hex files 
+├── verify_cocotb.py -> script that run tests and regressions 
+├── sim ->  directory get generate when run a test
+│   └── <tag> -> tag of the run  
+│       ├── <sim type>-<test name> -> test result directory contain all logs and wave related to the test
+│       ├── command.log -> command use for this run 
+│       └── runs.log -> contains status of the run fails and passes tests 
+├── tests -> directory contains all the tests 
+├── tests.json -> test list have all the tests, regressions and contain small description about every test 
+└── wb_models -> contains checkers and models for some caravel blocks 
+
+```