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.

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

Jump to bottom

chore: Add warning about no_std environment #1471

Merged
merged 3 commits into from
Aug 27, 2024
Merged

chore: Add warning about no_std environment #1471

merged 3 commits into from
Aug 27, 2024

Conversation

plafer
Copy link
Contributor

@plafer plafer commented Aug 27, 2024

Adds a warning in the main README that the only officially supported no_std environment is WASM

@plafer plafer added the no changelog This PR does not require an entry in the `CHANGELOG.md` file label Aug 27, 2024
@plafer plafer mentioned this pull request Aug 27, 2024
Merged
bitwalker
bitwalker reviewed Aug 27, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
bitwalker
bitwalker approved these changes Aug 27, 2024
View reviewed changes
Copy link
Contributor

@bitwalker bitwalker left a comment

Choose a reason for hiding this comment

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

Good idea! Just one small tweak I'd make, but otherwise 👍

bobbinth
bobbinth approved these changes Aug 27, 2024
View reviewed changes
Copy link
Contributor

@bobbinth bobbinth left a comment

Choose a reason for hiding this comment

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

Looks good! Thank you!

The only other potential thing is that we may want to add similar warnings to individual crates READMEs (e.g., here) as these will appear as main READMEs for the corresponding crates on crates.io.

@plafer
Copy link
Contributor Author

plafer commented Aug 27, 2024

The only other potential thing is that we may want to add similar warnings to individual crates READMEs (e.g., here) as these will appear as main READMEs for the corresponding crates on crates.io.

Added the statement to the 4 crates that have the std feature: miden, processor, prover, verifier.

bobbinth
bobbinth approved these changes Aug 27, 2024
View reviewed changes
Copy link
Contributor

@bobbinth bobbinth left a comment

Choose a reason for hiding this comment

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

All looks good! Thank you!

@plafer plafer merged commit d7c8933 into next Aug 27, 2024
9 checks passed
@plafer plafer deleted the plafer-no-std-warning branch August 27, 2024 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bitwalker bitwalker bitwalker approved these changes

@bobbinth bobbinth bobbinth approved these changes

Assignees
No one assigned
Labels
no changelog This PR does not require an entry in the `CHANGELOG.md` file
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@plafer @bitwalker @bobbinth