search

Hyle-org / verifiers-for-hyle

Apache License 2.0
10 stars 9 forks source link

Update README.md #18

Closed rishabhRsinghvi closed 2 months ago

rishabhRsinghvi commented 3 months ago

Pull Request Description

Title: Update README to Explain the Purpose and Structure of Verifiers for Hylé

Summary: This pull request updates the README file to provide a comprehensive description of the "Verifiers for Hylé" repository, explaining its purpose, code structure, and adding useful links. The previous README was a generic template, and it has now been tailored to reflect the specific details and functionalities of the "Verifiers for Hylé" project.

Changes Made:

  1. Project Introduction:

    • Added a new section to introduce the "Verifiers for Hylé" repository, highlighting its purpose and the role of verifiers within the Hylé ecosystem.

  2. Project Description:

    • Provided a detailed description of the repository's purpose, emphasizing the importance of verifiers and the repository's structure for easy maintenance and scalability.

  3. Code Structure:

    • Explained the modular approach adopted in the repository, where each verifier is housed in its own folder within the verifiers directory.
    • Included a detailed overview of the directory structure to help new contributors navigate the repository.

  4. Quick Start and Execution:

    • Retained and adapted the quick start guide and instructions for executing the project locally in development mode and remotely on Bonsai.
    • Ensured the instructions are clear and relevant to the repository's context.

  5. Creating a Project Based on This Template:

    • Provided guidance on how to create a new project based on the template, including searching for TODO comments and utilizing instructional resources.

  6. Useful Links:

    • Added links to the Hylé website and documentation.
    • Included additional resources such as the RISC Zero Developer Docs and example projects for further learning.

  7. Questions, Feedback, and Collaborations:

    • Updated the section to invite contributions and collaborations, providing links to Discord and Twitter for community engagement.