vtr-verilog-to-routing icon indicating copy to clipboard operation
vtr-verilog-to-routing copied to clipboard

Added a tutorial for running and creating unit tests.

Open nedsels opened this issue 9 months ago • 0 comments

Description

Modified the Developer Guide to give a basic tutorial for how to (1) run testers and (2) create unit tests, including a simple example.

Motivation and Context

There was only a brief tutorial on how to run unit tests in the guide previously: one instruction to run make && make test. This is not very helpful for anyone wanting to create their own unit tests, or run individual tests that target part of the software.

Types of changes

  • [ ] Bug fix (change which fixes an issue)
  • [ ] New feature (change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • [ ] My change requires a change to the documentation
  • [x] I have updated the documentation accordingly
  • [ ] I have added tests to cover my changes
  • [ ] All new and existing tests passed

nedsels avatar May 16 '24 20:05 nedsels