reorganizing readmes - Githubissues

risc0 / risc0-foundry-template

Template for integrating RISC Zero and Ethereum using Foundry and Bonsai

https://risczero.com

90 stars 53 forks source link

reorganizing readmes #57

Closed pdg744 closed 11 months ago

pdg744 commented 11 months ago

The current readme for the Bonsai foundry template is a huge wall of text. Would like to make it feel less scary for devs to start building.

This PR makes some steps in that direction, by:

moving the deployment instructions into a dedicated deployment-guide
removing the sections on Contracts and Methods from the main README
- the relevant content has been migrated into contracts/readme and methods/readme as appropriate

With these changes, the main README is less than half the previous size!

pdg744 commented 11 months ago

Note: This PR references some URLs that won't exist until https://github.com/risc0/website/pull/270 lands