Skip to content

Updates to README.md #248

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.

Sign up for GitHub

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
xdoardo merged 1 commit into from
Aug 14, 2026
Merged

Updates to README.md #248

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ or by opening a new discussion in this repository.

### The state of this project

As of late November 2025, we have a `rustc` that can produce
As of late July 2026, we have a `rustc` that can produce
programs for the CHERIoT platform. This `rustc` can then compile the
`compiler-builtins`, `core` and `alloc` libraries. We are currently in the
process of testing the functionalities exposed by these libraries.
process of testing the functionalities exposed by these libraries. Our tests
mainly involve the `codegen-llvm` and `coretests` test suites. For the latest
updates and numbers, please refer to the output of the CI job we run for every PR
and each push to the `main` and `beta` branches.

As of now, CHERIoT-specific bits such as accessing MMIO devices, shared
objects, defining compartments and using specific calling conventions are
Expand Down Expand Up @@ -71,6 +74,17 @@ As of now, the process of getting a final image for CHERIoT will entail

For an example of all the steps above, take a look at the [cheri/examples/hello_world](./cheri/examples/hello_world) directory.


### Contributions
Contributions are welcome. If you are planning to add a new CHERI-like target to this project,
please reach out to us beforehand so that we can plan the best way to do it together.
Otherwise, we will try to find the time to review your PR!

> [!IMPORTANT]
> Concerning AI contributions: for most CHERIoT things, we have a policy of zero LLM contributions.
> This also ensures that we're compliant with the (draft) [upstream policy](https://github.com/rust-lang/rust-forge/pull/1040)
> on LLM use, which is important to ensure we can upstream our changes in the future.

<p align="center">
</br></br>
Something went wrong? Please <a href="https://github.com/CHERIoT-Platform/cheri-rust/issues/new?template=bug_report.md">raise an issue</a>
Expand Down
Loading