add more to docs | 1st spelling pass | more links | proper formatting

This commit is contained in:
abejgonzalez
2019-05-27 15:29:09 -07:00
parent bc54b24b85
commit dde22a969b
25 changed files with 471 additions and 429 deletions

View File

@@ -1,3 +1,12 @@
FIRRTL
================================
`FIRRTL <https://github.com/freechipsproject/firrtl>`__ is an intermediate representation of your circuit.
It is emitted by the Chisel compiler and is used to translate Chisel source files into another representation such as Verilog.
Without going into too much detail, FIRRTL is consumed by a FIRRTL compiler (another Scala program) which passes the circuit through a series of circuit-level transformations.
An example of a FIRRTL pass (transformation) is one that optimizes out unused signals.
Once the transformations are done, a Verilog file is emitted and the build process is done.
For more information on please visit their `website <https://freechipsproject.github.io/firrtl/>`__.