Merge pull request #255 from ucb-bar/random-tools-docs

add firrtl interpreter to the docs [ci skip]
This commit is contained in:
Abraham Gonzalez
2019-09-25 18:42:17 -07:00
committed by GitHub

View File

@@ -1,5 +1,9 @@
Treadle
Treadle and FIRRTL Interpreter
==============================
`Treadle <https://github.com/freechipsproject/treadle>`__ is a circuit simulator that directly executes FIRRTL.
It is especially useful for interactive debugging and small unit tests that benefit from a low-overhead simulator.
`Treadle <https://github.com/freechipsproject/treadle>`__ and
`FIRRTL Interpreter <https://github.com/freechipsproject/firrtl-interpreter>`__
are circuit simulators that directly execute FIRRTL (specifically low-firrtl IR).
Treadle is the replacement for FIRRTL Interpreter but FIRRTL Interpreter is still used within some
projects. Treadle is useful for simulating modules in a larger SoC design. Many projects
use Treadle for interactive debugging and a low-overhead simulator.