aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/README.md b/README.md
index 8e04bb31..1b98f577 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,17 @@
# firrtl
-## Flexible Internal Representation for RTL
+#### Flexible Internal Representation for RTL
-### This repository contains the compiler for .firrtl files.
-### It is currently being developed in stanza, with the end-goal to translate into scala for ease of other people to use.
-### This decision was made for multiple reasons:
-#### 1. Previous development had already been done in stanza
-#### 2. Most of the passes are relatively language independent
-#### 3. Stanza is easier to develop in than scala bc less-strict type system
-#### 4. As a favor, its useful to develop in stanza to give Patrick some language tips :)
-### The hardest part to port will likely be the parser, but we hope to use an scala parser for the port.
+ This repository contains the compiler for .firrtl files.
+ It is currently being developed in stanza, with the end-goal to translate into scala for ease of other people to use.
+ This decision was made for multiple reasons:
+ 1. Previous development had already been done in stanza
+ 2. Most of the passes are relatively language independent
+ 3. Stanza is easier to develop in than scala bc less-strict type system
+ 4. As a favor, its useful to develop in stanza to give Patrick some language tips :)
+ The hardest part to port will likely be the parser, but we hope to use an scala parser for the port.
-### Installation instructions (for Mac):
-#### *Disclaimer*: This project is going through development stages so there is no guarantee anything works.
+#### Installation instructions (for Mac):
+*Disclaimer*: This project is going through development stages so there is no guarantee anything works.
`git clone https://github.com/ucb-bar/firrtl # Clone repository`
`make install # Stanza installation`
`pip install lit # Install lit (this assumes you have pip installed)`