adding readmes (#17)

* adding readmes * clarifying host & guest Co-authored-by: Tim Zerrell <[email protected]> --------- Co-authored-by: Tim Zerrell <[email protected]>
risc0 · Jul 31, 2023 · 551c80d · 551c80d
1 parent 87216a6
commit 551c80d
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/contracts/README.md b/contracts/README.md
@@ -0,0 +1,5 @@
+# Bonsai Solidity Contracts
+
+This folder contains the Solidity contract for deploying a Bonsai application through the Ethereum relay. 
+
+The contract demonstrates one pattern for offloading the computation of an expensive or difficult to implement function to a RISC Zero guest running on Bonsai.
diff --git a/methods/README.md b/methods/README.md
@@ -0,0 +1,11 @@
+## zkVM Methods
+
+This folder contains the [zkVM] portion of your [Bonsai] application. 
+In typical use cases, you will only need to edit the code inside `guest/src/bin` which is where you write the source code for your [guest program].
+
+To learn more about the architecture of Bonsai apps and zkVM apps, check out the [developer documentation]. Note that the Bonsai Ethereum Relay acts as the zkVM host and so you do not need to write zkVM host code yourself.
+
+[guest program]: https://dev.risczero.com/terminology#guest-program
+[developer documentation]: https://dev.risczero.com
+[zkVM]: https://dev.risczero.com/zkvm
+[Bonsai]: https://dev.risczero.com/bonsai/
diff --git a/methods/guest/src/bin/README.md b/methods/guest/src/bin/README.md
@@ -0,0 +1,7 @@
+# Guest Methods
+
+Each file in this folder will be compiled to an ELF file, and the execution of the resulting ELF file will be proven by the zkVM.
+
+To learn more about guest methods, check out the zkVM [developer docs]. 
+
+[developer docs]: https://dev.risczero.com/zkvm