From 35b325dc8194fb24c76a3ab447fa9758fcbd5e5c Mon Sep 17 00:00:00 2001
From: Adam Izraelevitz <azidar@gmail.com>
Date: Wed, 15 Mar 2017 12:16:22 -0700
Subject: [PATCH] Update README.md with example invocation (#16)

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

diff --git a/README.md b/README.md
index 6429c26a..bc6f3d9b 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,15 @@ Useful utilities for BAR projects
 
 Passes/Transforms that could be useful if added here:
 * Check that a module was de-duplicated. Useful for MIM CAD flows and currently done in python.
+
+Be sure to publish-local the following repositories:
+* ucb-bar/chisel-testers (requires ucb-bar/firrtl-interpreter)
+* ucb-bar/firrtl
+
+Example Usage:
+```
+sbt
+> compile
+> project tapeout
+> run-main barstools.tapeout.transforms.GenerateTop -i <myfile>.fir -o <myfile>.v --syn-top <mysyntop> --harness-top <myharnesstop>
+```