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 #33

Merged
merged 1 commit into from
Nov 7, 2024
Merged

Update README #33

merged 1 commit into from
Nov 7, 2024

Conversation

simongdavies
Copy link
Contributor

Updates README to make setup instructions a little clearer

@simongdavies simongdavies added the area/documentation Improvements or additions to documentation label Nov 7, 2024
Copy link
Contributor

@devigned devigned left a comment

Choose a reason for hiding this comment

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

lgtm!

@jprendes
Copy link
Contributor

jprendes commented Nov 7, 2024

I would prefer adding the targets to rust-toolchains.toml with:

[toolchain]
channel = "1.82.0"
# if you update this, don't forget to change the pinned version
# of nightly we use in the fuzzing workflow.

targets = [ "x86_64-unknown-linux-none", "x86_64-pc-windows-msvc" ]

and simplifying the instructions in README.md for the 99% case

2. [Rust](https://www.rust-lang.org/tools/install). If you are using rustup you can move to the next step,
   otherwise make sure to install the toolchain as specified in `rust-toolchain.toml`.

@jprendes
Copy link
Contributor

jprendes commented Nov 7, 2024

I created #34

Signed-off-by: Simon Davies <[email protected]>
@simongdavies simongdavies merged commit 89308de into main Nov 7, 2024
15 checks passed
@simongdavies simongdavies deleted the update-readme branch November 7, 2024 19:56
danbugs pushed a commit to danbugs/hyperlight that referenced this pull request Nov 7, 2024
Signed-off-by: Simon Davies <[email protected]>
Signed-off-by: danbugs <[email protected]>
danbugs pushed a commit to danbugs/hyperlight that referenced this pull request Nov 7, 2024
Signed-off-by: Simon Davies <[email protected]>
Signed-off-by: danbugs <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants