Refactor: rename SimDUT, restructure DUT simulation and test flow
This commit is contained in:
@@ -0,0 +1,35 @@
|
||||
Getting Started
|
||||
===============
|
||||
|
||||
This guide helps you bootstrap your first test project using the framework.
|
||||
|
||||
Setup
|
||||
-----
|
||||
|
||||
1. Clone the repo:
|
||||
.. code-block:: bash
|
||||
|
||||
git clone ssh://git@git.corwin.life:23231/hw-test-template.git
|
||||
|
||||
2. Create a virtual environment and install dependencies:
|
||||
.. code-block:: bash
|
||||
|
||||
python -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
|
||||
3. Run a simulation-mode test:
|
||||
.. code-block:: bash
|
||||
|
||||
pytest --sim
|
||||
|
||||
Next Steps
|
||||
----------
|
||||
|
||||
- Edit or extend the `SimDUT` class for your DUT logic
|
||||
- Add custom test cases in `tests/`
|
||||
- Build docs using:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sphinx-build -b html . _build/html
|
||||
|
||||
Reference in New Issue
Block a user