Refactor: rename SimDUT, restructure DUT simulation and test flow
This commit is contained in:
31
docs/usage.rst
Normal file
31
docs/usage.rst
Normal file
@@ -0,0 +1,31 @@
|
||||
Usage Guide
|
||||
===========
|
||||
|
||||
This section describes how to set up and run the test framework.
|
||||
|
||||
Quick Start
|
||||
-----------
|
||||
|
||||
1. Clone the repo and create a virtual environment:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
python -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
|
||||
2. Run tests in simulation mode:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pytest --sim
|
||||
|
||||
3. View the report:
|
||||
|
||||
- Open `report.html` in your browser.
|
||||
|
||||
Switching Between Sim and Hardware
|
||||
----------------------------------
|
||||
|
||||
Use the `--sim` flag to control which backend is used.
|
||||
The system defaults to skipping hardware tests
|
||||
Reference in New Issue
Block a user