aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.md b/README.md
index de4e8275..eb0a56ac 100644
--- a/README.md
+++ b/README.md
@@ -6,18 +6,18 @@ Description:
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 :)
+ 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:
-- Disclaimer: This project is going through development stages so there is no guarantee anything works.
-- These installations are for a mac. Won't work for a Unix-based system.
- `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)`
- `make build # Build firrtl`
- `make check # Run tests`
- `make # Build & test`
+ `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)`
+ `make build # Build firrtl`
+ `make check # Run tests`
+ `make # Build & test`