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

docs: add guides for compiling rust->masm #91

Merged
merged 5 commits into from
Jan 16, 2024
Merged

Conversation

bitwalker
Copy link
Contributor

This expands the documentation, and adds some useful guides for compiling "manually" from Rust to Miden Assembly, in two parts. I also fixed a couple small things discovered while testing.

There are still a number of things to document and expand on, but wanted to get this pushed ASAP. Additionally, I want to turn the example crate from the guides into a crate under examples and add it to our test suite, I'll do that in a separate PR though.

NOTE: I found some additional bugs/tweaks/etc that I have not documented yet while putting this together, I'll do that shortly.

@bitwalker bitwalker added the documentation Improvements or additions to documentation label Jan 15, 2024
@bitwalker bitwalker requested a review from greenhat January 15, 2024 09:18
@bitwalker bitwalker self-assigned this Jan 15, 2024
@bitwalker
Copy link
Contributor Author

@greenhat I needed to update our rust-toolchain.toml file and the toolchain used in CI, since recent nightlies have broken some of your recent expect tests due to Wasm codegen changes. I moved us to the nightly release corresponding to the 1.75 stable release.

Once 1.76 is released on stable, we should be able to move back to stable for regular development anyway, but for now we'll have to keep tabs on nightly releases manually to see when things change on us.

@bitwalker bitwalker force-pushed the bitwalker/docs-examples branch from d4bb642 to 86ed256 Compare January 15, 2024 16:54
Copy link
Contributor

@greenhat greenhat left a comment

Choose a reason for hiding this comment

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

LGTM! Just a note on wee_alloc.

Makefile.toml Outdated Show resolved Hide resolved
docs/src/guides/rust_to_wasm.md Outdated Show resolved Hide resolved
docs/src/guides/rust_to_wasm.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants