project: update readme

Wonicon · Apr 23, 2021 · 9a69ef8 · 9a69ef8
1 parent d24562b
commit 9a69ef8
Showing 1 changed file with 4 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -3,20 +3,12 @@
 This tool utilizes ANTLR4 to parse Verilog2001 and collects parameter and port information
 to create a chisel3 `BlackBox` definition, which can be used when hybriding chisel3 and Verilog code.
 
-## How To Build
+## How To Build & Use
 
 ```
 $ # In the project root dir
-$ wget http://www.antlr.org/download/antlr-4.6-complete.jar
-$ java -cp antlr-4.6-complete.jar Verilog2001.g4
-$ javac *.java
-$ java -x .
-```
-
-## How To Use
-
-```
-$ java -cp . Main some.v >> BlackBox.scala
+$ ./gradlew installDist
+$ app/build/install/app/bin/app <path-to-verilog-file>
 ```
 
 ## Limitation
@@ -30,4 +22,4 @@ but I think it too expensive to figure out constant calculation. Therefore the t
 
 ## Credit
 
-The `Verilog2001.g4` grammar is obtained from [grammars-v4](https://github.com/antlr/grammars-v4).
+The `Verilog2001.g4` grammar is obtained from [grammars-v4](https://github.com/antlr/grammars-v4).