Skip to content

Commit

Permalink
docs: Move image up and update install section (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanuppal authored Jan 28, 2025
1 parent 4157f41 commit 43de9be
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Add this library to your `Cargo.toml` like any other library. Use hardware
modules as `struct`s like any other Rust `struct`. Hook them up to `tokio` or
`serde` even.

![Early example of using this with Spade](./assets/demo-alpha.png)

## πŸ”₯ Motivation

Why does hardware testing suck? Consider the ways we have to test
Expand Down Expand Up @@ -44,8 +46,6 @@ Still, a lot of these are less than optimal.

## ✨ Features

![Early example of using this with Spade](./assets/demo-alpha.png)

- πŸš€ Minimal overhead over directly using `verilator`
- πŸ”Œ Works completely drop-in in your existing projects
- πŸ¦€ Rust. Did I say Rust?
Expand All @@ -60,6 +60,7 @@ Still, a lot of these are less than optimal.
dumbname is currently in development.
You can currently install the crates via `git` specifications.
(I'm aware that this is not explained well.)
Look at the tutorials in the Usage section for detailed instructions.

## ❓ Usage

Expand Down

0 comments on commit 43de9be

Please sign in to comment.