Skip to content

Update README #604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 19, 2025
Merged

Update README #604

merged 1 commit into from
Jul 19, 2025

Conversation

ChinYikMing
Copy link
Collaborator

  • the customizable bootargs feature was introduced in Customize bootargs for system emulation  #534, but the README was not updated at that time.

  • build-linux-img should be build-linux-image. See mk/tools.mk.

  • highlight WebAssembly support in feature list.

Copy link

Bito Automatic Review Skipped - Files Excluded

Bito didn't auto-review this change because all changed files are in the exclusion list for automatic reviews. No action is needed if you didn't intend for the agent to review it. Otherwise, to manually trigger a review, type /review in a comment and save.
You can change the excluded files settings here, or contact your Bito workspace admin at jserv.tw@gmail.com.

README.md Outdated
@@ -26,10 +26,11 @@ Features:
* Fast interpreter for executing the RV32 ISA
* Fast interpreter that faithfully executes the complete RV32 instruction set
* Full coverage of RV32I / RV32E plus the M (integer multiply–divide), A (atomics), F (single-precision floating-point), C (compressed), and Zba/Zbb/Zbc/Zbs bit-manipulation extensions
* Built-in ELF loader for user-mode emulation
* Built-in ELF loader for user-space emulation
Copy link
Contributor

Choose a reason for hiding this comment

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

“Built‑in ELF loader for user‑mode emulation” is the clearer, more conventional wording.

QEMU and most academic papers distinguish “user‑mode emulation” (running a single user process on the host kernel) from “system‑mode emulation” (full guest OS). Using the same term makes your simulator’s capabilities immediately recognizable to anyone familiar with QEMU.

“Mode” pairs naturally with other RISC‑V privilege levels (M‑mode, S‑mode, U‑mode). “User‑space” is correct but can blur the distinction between CPU privilege levels and the broader concept of an OS’s address‑space separation.

- the customizable bootargs feature was introduced in sysprog21#534, but the
README was not updated at that time.

- build-linux-img should be build-linux-image. See mk/tools.mk.

- highlight WebAssembly support in feature list.
Copy link

Bito Automatic Review Skipped - Files Excluded

Bito didn't auto-review this change because all changed files are in the exclusion list for automatic reviews. No action is needed if you didn't intend for the agent to review it. Otherwise, to manually trigger a review, type /review in a comment and save.
You can change the excluded files settings here, or contact your Bito workspace admin at jserv.tw@gmail.com.

@jserv jserv merged commit 6fd635b into sysprog21:master Jul 19, 2025
8 checks passed
@jserv
Copy link
Contributor

jserv commented Jul 19, 2025

Thank @ChinYikMing for contributing!

@ChinYikMing ChinYikMing deleted the update-readme branch July 19, 2025 09:49
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.

2 participants