Skip to content

Commit

Permalink
update build name and version
Browse files Browse the repository at this point in the history
  • Loading branch information
dz333 committed Nov 7, 2019
1 parent fef6656 commit 956ffc6
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 14 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@

##### Installation
1. Clone the repository:
```git clone https://github.com/ucb-bar/firrtl; cd firrtl```
```git clone https://github.com/apl-cornell/sirrtl.git; cd sirrtl```
1. Compile firrtl: ```sbt compile```
1. Run tests: ```sbt test```
1. Build executable (`utils/bin/firrtl`): ```sbt assembly```
* **Note:** You can add `utils/bin` to your path to call firrtl from other processes
1. Build executable (`utils/bin/sirrtl`): ```sbt assembly```
* **Note:** You can add `utils/bin` to your path to call sirrtl from other processes
1. Publish this version locally in order to satisfy other tool chain library dependencies:
```
sbt publish-local
Expand All @@ -42,10 +42,10 @@ sbt
> test
```

##### Using Firrtl as a commandline tool
##### Using Sirrtl as a commandline tool
```
utils/bin/firrtl -i regress/rocket.fir -o regress/rocket.v -X verilog // Compiles rocket-chip to Verilog
utils/bin/firrtl --help // Returns usage string
utils/bin/sirrtl -i regress/rocket.fir -o regress/rocket.v -X verilog // Compiles rocket-chip to Verilog
utils/bin/sirrtl --help // Returns usage string
```

##### Other Tools
Expand Down
2 changes: 1 addition & 1 deletion RELEASE_NOTES
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ How to Use SecureFirrtl:
for normal Firrtl. Below is an example execution of secure firrtl which generates an
intermediate representation AND a checkable Z3 file.

./firrtl -i circuit.fir -o circuit.lbl.fir -z circuit.z3 -X labeled
./sirrtl -i circuit.fir -o circuit.lbl.fir -z circuit.z3 -X labeled

- The "labeled" compiler (specified with the -X flag) tells the compiler to generate
labeled MidFirrtl (with inferred labels). The '-z' flag tells the compiler to emit
Expand Down
11 changes: 5 additions & 6 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,14 @@ site.includeScaladoc()

ghpages.settings

git.remoteRepo := "[email protected]:ucb-bar/firrtl.git"

git.remoteRepo := "[email protected]:apl-cornell/sirrtl.git"
// Firrtl code

organization := "edu.berkeley.cs"

name := "firrtl"
name := "sirrtl"

version := "1.1-SNAPSHOT"
version := "0.2"

scalaVersion := "2.11.7"

Expand All @@ -36,11 +35,11 @@ libraryDependencies += "net.jcazevedo" %% "moultingyaml" % "0.2"

// Assembly

assemblyJarName in assembly := "firrtl.jar"
assemblyJarName in assembly := "sirrtl.jar"

test in assembly := {} // Should there be tests?

assemblyOutputPath in assembly := file("./utils/bin/firrtl.jar")
assemblyOutputPath in assembly := file("./utils/bin/sirrtl.jar")

// ANTLRv4

Expand Down
2 changes: 1 addition & 1 deletion utils/bin/firrtl → utils/bin/sirrtl
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

# This may be a brittle way to find $(root_dir)/utils/bin, is there a better way?
path=`dirname "$0"`
cmd="java -cp ${path}/firrtl.jar firrtl.Driver ${@:1}"
cmd="java -cp ${path}/sirrtl.jar firrtl.Driver ${@:1}"
eval $cmd

0 comments on commit 956ffc6

Please sign in to comment.