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

Commit

Permalink
README: bump.
Browse files Browse the repository at this point in the history
  • Loading branch information
kivikakk committed May 29, 2024
1 parent f39ee8b commit 787ea06
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,44 @@ A little framework to build HDL projects in Chisel with open-source toolchains.

## Examples

* <https://github.com/kivikakk/sevsegsim>
* <https://github.com/kivikakk/spifrbb> — used as part of a presentation on
CXXRTL at the Yosys Users Group ([transcript/slides][chisel-and-cxx])
* <https://github.com/kivikakk/sevsegsim> — graphical demo of CXXRTL integration

[chisel-and-cxx]: https://kivikakk.ee/digital/2024/05/28/chisel-and-cxx/

```console
$ sbt run
sevsegsim 0.1.0 (Chryse 0.1.0-SNAPSHOT)
spifrbb 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 onto icebreaker, and optionally program it.
Build the design, and optionally program it.
-b, --board <board> Board to build for. Choices: icebreaker, ulx3s-45f
-F, --full-stacktrace Include full Chisel stacktraces
-p, --program Program the design onto the board after building
-h, --help Show help message

Subcommand: cxxsim
Run the C++ simulator tests.
-c, --compile Compile only; don't run
-d, --debug Generate source-level debug information
-O, --optimize Build with optimizations
-v, --vcd <file> Output a VCD file when running cxxsim (passes --vcd <file>
to the executable)
-h, --help Show help message
-c, --compile Compile only; don't run
-d, --debug Generate source-level debug information
-f, --force Clean before build
-O, --optimize Build with optimizations
-p, --platform <platform> CXXRTL platform to use. Choices: wb, bb
-v, --vcd <file> Output a VCD file when running cxxsim (passes
--vcd <file> to the executable)
-h, --help Show help message

trailing arguments:
<arg> ... (not required) Other arguments for the cxxsim executable

Subcommand: rom
Build the Stackyem ROM image, and optionally program it.
-p, --program <board> Program the ROM onto the board. Choices: icebreaker,
ulx3s-45f
-h, --help Show help message
```

## Quick feature overview
Expand Down

0 comments on commit 787ea06

Please sign in to comment.