aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 526c94d4f2525a38a7afc99e24b249c183507ef6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# firrtl
Flexible Internal Representation for RTL

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 :)   
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.
  
  `; Clone repository
    git clone https://github.com/ucb-bar/firrtl

  ; Stanza installation
    `make install

  ; Install lit (this assumes you have pip installed)
    pip install lit

  ; Build firrtl
    make build

  ; Run tests
    make check

  ; Build & test
    make`