Update README.

Signed-off-by: James Goppert <[email protected]>
CogniPilot · Nov 11, 2024 · 4b7122a · 4b7122a
1 parent 8f92f54
commit 4b7122a
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git a/.README.md.swp b/.README.md.swp
diff --git a/README.md b/README.md
@@ -1,11 +1,34 @@
-# rumoca
+# rumoca ![CI](https://github.com/github/jgoppert/rumoca/workflows/rust.yml/badge.svg)
 
 A Modelica Compiler written in RUST.
 
-## Generating, Testing, and Installing
+## Building, Testing, and Running
 
 ```bash
 cargo build
 cargo run
 cargo test
+cargo run -- --filename src/model.mo --generator sympy
 ```
+
+## Installing
+
+```bash
+cargo install --path .
+```
+
+Make sure you add your rust bin path to your .bashrc and source it, then:
+
+```bash
+$ rumoca --help
+Modelica Compiler
+
+Usage: rumoca [OPTIONS] --filename <FILENAME> --generator <GENERATOR>
+
+Options:
+  -f, --filename <FILENAME>    The filename to compile
+  -v, --verbose                Verbose output
+  -g, --generator <GENERATOR>  Generator to Use [possible values: sympy, json, casadi-mx, casadi-sx]
+  -h, --help                   Print help
+  -V, --version                Print version
+```