aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/HOWTO.testbench
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/HOWTO.testbench')
-rw-r--r--contrib/HOWTO.testbench12
1 files changed, 12 insertions, 0 deletions
diff --git a/contrib/HOWTO.testbench b/contrib/HOWTO.testbench
new file mode 100644
index 0000000..3be00d6
--- /dev/null
+++ b/contrib/HOWTO.testbench
@@ -0,0 +1,12 @@
+
+"testbenches" are helpful wrappers which exersize a piece of code. they should
+live in ./tb/, end in "_tb.v" or "_tb.vhd", and have a signal file (ending in
+"_tb.wcfg") associated with the same name. update the 'tbfiles' list in
+Makefile. invoke the isim GUI with "make isim/name_tb" (for tb/name_tb.v). if
+you make a source code change and don't want to reload the whole GUI, you can
+do "make resim/name_tb" and then click the "Re-load" button.
+
+testbenches which can act as headless unit tests (reporting pass/fail by
+printing to stdout) should be added to the 'alltests' list in Makefile. run the
+test with 'make test/name_tb'; run all tests with 'make tests'.
+