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

Jump to bottom

Document SP1 Programs #166

Open
gjermundgaraba opened this issue Dec 10, 2024 · 0 comments
Open

Document SP1 Programs #166

gjermundgaraba opened this issue Dec 10, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@gjermundgaraba
Copy link
Contributor

Move all existing SP1 programs documentation to programs/sp1-programs/README.md that has at least the following information:

  • Purpose and intended use case
  • High level architectural diagram with Mermaid
  • How to build and test
  • How to integrate/use
    • Short about relayer and link `programs/relayer/README.md´
    • Briefly about how to use the circuits yourself and the interface (inputs and outputs)

In addition we should make sure to have links to other relevant documentation (SP1) and
@gjermundgaraba gjermundgaraba added the documentation Improvements or additions to documentation label Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
IBC-GO Eureka
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gjermundgaraba