Skip to content

Conversation

2011eric
Copy link
Collaborator

@2011eric 2011eric commented Feb 7, 2023

Since this project has migrated to RISCOF,
the information in README is also updated.

@jserv jserv changed the title Update README.md Reflect the introduction of RISCOF Feb 7, 2023
@jserv jserv requested a review from Risheng1128 February 7, 2023 13:59
Copy link
Contributor

@jserv jserv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Read https://cbea.ms/git-commit/ and write better git commit messages.

@2011eric 2011eric force-pushed the readme branch 2 times, most recently from 6e46818 to b70dcaa Compare February 7, 2023 14:17
* macOS: `brew install sdl2`
* Ubuntu Linux / Debian: `sudo apt install libsdl2-dev`

Install [RISCOF](https://riscof.readthedocs.io/en/stable/installation.html#install-riscof).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the url should use the home page of riscof. Like the following:

[RISCOF](https://riscof.readthedocs.io/en/stable/)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

riscof is only required if you want to execute riscv-arch-tests. So, move to the dedicated section.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rv32emu/README.md

Lines 71 to 74 in b70dcaa

[RISC-V GNU Compiler Toolchain](https://github.com/riscv-collab/riscv-gnu-toolchain) or [xPack GNU RISC-V Embedded GCC](https://xpack.github.io/riscv-none-elf-gcc/) should be prepared in advance. You can obtain prebuilt GNU toolchain for `riscv32-elf` via [Automated Nightly Release](https://github.com/riscv-collab/riscv-gnu-toolchain/releases). Then, run the following command:
```shell
make arch-test
```

What about the old description of running risv-arch-test?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly. Improve this description.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to run the old framework now?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, old 2.x framework is deprecated. We shall no longer rely on it.

@jserv
Copy link
Contributor

jserv commented Feb 8, 2023

https://github.com/RinHizakura/riscv-emulator/commits/main # Recently, @RinHizakura is moving toward RISCOF for his RISC-V emulator. @2011eric, check if the wording in README.md is precise for rv32emu.

@Risheng1128
Copy link
Collaborator

In neorv32-riscof, there is some description of RISCOF in README.md.

The project has migrated to RISCOF,
this commit delete the description of the old framework
and add the installation guide of RISCOF.
@jserv jserv merged commit 503c57e into sysprog21:master Feb 18, 2023
vestata pushed a commit to vestata/rv32emu that referenced this pull request Jan 24, 2025
Reflect the introduction of RISCOF
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants