Skip to content

Commit

Permalink
docs: Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
felix-andreas committed Jul 9, 2024
1 parent aeac535 commit e4e45ca
Showing 1 changed file with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,42 @@
# RISC-V core

A minimal RV32I RISC-V core implement in Rust. This is just a weekend project, but some tests actually pass!
A minimal RV32I RISC-V core implement in Rust. This is just a weekend project, but all `rv32ui` tests actually pass!

## Usage
## RISC-V tests

Download and compile tests from https://github.com/riscv/riscv-tests. Or, run:

```
cd web
trunk serve
nix build .#riscv-tests
```

## Compile programs
Then, run:

```
riscv32-none-elf-gcc -march=rv32i -mabi=ilp32 -c fib.c
riscv32-none-elf-objdump -d fib.o
cargo run -p riscv --example run_tests -- <path/to/tests>
```

## RISC-V tests
where `<path/to/tests>` should be either `riscv-tests/isa` or `result`, depending on if you compilied the tests manually or with Nxi. The command runs all `rv32ui-p*` tests. All of them should pass.

Download and compile tests from https://github.com/riscv/riscv-tests. Or, run:
## Visualization (WIP)

Currently working on a visualization. You can see a work in progress version at: https://riscv.felixandreas.me/

### Usage

```
nix build .#riscv-tests
cd web
trunk serve
```

Then, run:
### Compile programs

```
cargo run -p riscv --example run_tests -- <path/to/tests>
riscv32-none-elf-gcc -march=rv32i -mabi=ilp32 -c fib.c
riscv32-none-elf-objdump -d fib.o
```

where `<path/to/tests>` should be either `riscv-tests/isa` or `result`, depending on if you compilied the tests manually or with Nxi. The command runs all `rv32ui-p*` tests. All of them should pass.

## TODO
### TODO

* Fix program
* animate change
Expand Down

0 comments on commit e4e45ca

Please sign in to comment.