aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAdam Izraelevitz2017-03-09 17:28:24 -0800
committerAdam Izraelevitz2017-03-10 10:33:10 -0800
commit68c49fcaa107bcdac2aaf0ab450e9500e6777bdd (patch)
tree2221cb4eb054c8e8d01d4cb563c7b419691c4575 /README.md
parent1c867150215511930c53c2f15f1d5f4e3fee666c (diff)
Added comments and section in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index a7ad0b85..5c41879a 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,15 @@
sbt publish-local
```
+##### Transform Writing Tutorial
+
+To write a Firrtl transform, start with [src/main/scala/tutorial/AnalyzeCircuit.scala](https://github.com/ucb-bar/firrtl/blob/master/src/main/tutorial/AnalyzeCircuit.scala).
+To run this example:
+```
+sbt assembly
+./utils/bin/firrtl -td regress -tn rocket --custom tutorial.AnalyzeCircuit
+```
+
##### Useful sbt Tips
1. Run a single test suite:
`sbt "testOnly firrtlTests.UnitTests"`