Skip to content
This repository has been archived by the owner on Jun 16, 2024. It is now read-only.

Commit

Permalink
README: add example usage.
Browse files Browse the repository at this point in the history
  • Loading branch information
kivikakk committed May 22, 2024
1 parent 8a9d37d commit 9171936
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,38 @@ its own HDL depending on how much I love Scala. :)

## Example

<https://github.com/kivikakk/sevsegsim>.
<https://github.com/kivikakk/sevsegsim>

```console
$ sbt run
sevsegsim 0.1.0 (Chryse 0.1.0-SNAPSHOT)
-h, --help Show help message
-v, --version Show version of this program

Subcommand: build
Build the design, and optionally program it.
-b, --board <arg> Board to build for. Choices: icebreaker
-F, --full-stacktrace Include full Chisel stacktraces
--no-full-stacktrace
-p, --program Program the design onto the board after building
--no-program
-h, --help Show help message

Subcommand: cxxsim
Run the C++ simulator tests.
-c, --compile Compile only; don't run
--no-compile
-d, --debug Generate source-level debug information
--no-debug
-O, --optimize Build with optimizations
--no-optimize
-v, --vcd <arg> Output a VCD file when running cxxsim (passes --vcd <file>
to the executable)
-h, --help Show help message

trailing arguments:
trailing (not required) Other arguments for the cxxsim executable
```

## Quick feature overview

Expand Down

0 comments on commit 9171936

Please sign in to comment.