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

WEB3-155: Fix two broken links in methods/README.md #136

Merged
merged 2 commits into from
Oct 15, 2024
Merged

WEB3-155: Fix two broken links in methods/README.md #136

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a922321
fix a couple of broken links and format md
nategraf Sep 30, 2024
6e65326
Merge branch 'main' into victor/fix-links-sep30
Wollac Oct 14, 2024
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
13 changes: 5 additions & 8 deletions methods/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,24 @@ This is where you will define one or more [guest programs] to act as a coprocess

> In typical use cases, the only code in this directory that you will need to edit is inside [guest/src/bin].

## Writing Guest Code

### Writing Guest Code

To learn to write code for the zkVM, we recommend [Guest Code 101].
To learn to write code for the zkVM, we recommend the [Hello World tutorial][zkvm-hello-world].

Examples of what you can do in the guest can be found in the [RISC Zero examples].


### From Guest Code to Binary File
## From Guest Code to Binary File

Code in the `methods/guest` directory will be compiled into one or more binaries.

Build configuration for the methods is included in `methods/build.rs`.

Each will have a corresponding image ID, which is a hash identifying the program.


[zkVM]: https://dev.risczero.com/zkvm
[RISC Zero]: https://www.risczero.com/
[guest programs]: https://dev.risczero.com/terminology#guest-program
[on-chain logic]: ../contracts/
[guest/src/bin]: ./guest/src/bin/
[Guest Code 101]: https://dev.risczero.com/zkvm/developer-guide/guest-code-101
[RISC Zero examples]: https://github.com/risc0/tree/v0.18.0/examples
[zkvm-hello-world]: https://dev.risczero.com/api/zkvm/tutorials/hello-world
[RISC Zero examples]: https://github.com/risc0/risc0/tree/release-1.1/examples
Loading