Skip to content
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

Update README.md #61

Merged
merged 2 commits into from
Jul 19, 2024
Merged

Update README.md #61

merged 2 commits into from
Jul 19, 2024

Conversation

rmn30
Copy link
Collaborator

@rmn30 rmn30 commented Jul 16, 2024

Add link to latest pdf version of arch doc hosted on github pages.

Add link to latest pdf version of arch doc hosted on github pages.
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated

# Building

The easiest way to use this emulator is to use the dev container for the [CHERIoT RTOS](http://github.com/microsoft/cheriot-rtos).
The easiest way to use the emulator is to use the dev container for the [CHERIoT RTOS](http://github.com/microsoft/cheriot-rtos).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Perhaps add something like an instruction for people who want to just run the model, to fetch the container:

$ docker pull ghcr.io/cheriot-platform/devcontainer
$ docker run --rm -it ghcr.io/cheriot-platform/devcontainer
$ /cheriot-tools/bin/cheriot_sim

Copy link
Contributor

Choose a reason for hiding this comment

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

And a parenthetical link to https://github.com/CHERIoT-Platform/devcontainer for the curious, perhaps.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Running those commands isn't very useful without anything to run so you need a bind mount and compiler. At this point I think it's better to just refer to the CHERIoT-RTOS getting started guide (which itself looks like it could be improved).

Address review comments.
@rmn30 rmn30 merged commit e767a16 into main Jul 19, 2024
3 checks passed
@rmn30 rmn30 deleted the rmn30-readme-update branch July 19, 2024 12:19
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