From 68c49fcaa107bcdac2aaf0ab450e9500e6777bdd Mon Sep 17 00:00:00 2001
From: Adam Izraelevitz
Date: Thu, 9 Mar 2017 17:28:24 -0800
Subject: Added comments and section in README

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'README.md')

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"`
-- 
cgit v1.2.3