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

add README.md #39

Merged
merged 31 commits into from
Apr 17, 2024
Merged

add README.md #39

merged 31 commits into from
Apr 17, 2024

Commits on Apr 17, 2024

  1. Initialize the README.md with a sketch of the structure

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    959dac8 View commit details
    Browse the repository at this point in the history

  2. add warning and draft diagram

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    0f86202 View commit details
    Browse the repository at this point in the history

  3. add authors & years to schemes, add a pre-sketch of the 'development'… 

    … section
    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    fae49f8 View commit details
    Browse the repository at this point in the history

  4. Readme: add link to Carlos talk on folding schemes

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    2494806 View commit details
    Browse the repository at this point in the history

  5. readme: sketch sections: offchain & onchain decider, add todo for ref… 

    …erences
    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    a93095e View commit details
    Browse the repository at this point in the history

  6. readme: add example of FCircuit & folding

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    8019663 View commit details
    Browse the repository at this point in the history

  7. Readme: add lib pipeline diagram, add decider code example

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    251856d View commit details
    Browse the repository at this point in the history

  8. add cyclefold-nova-diagram.png, decider-onchain-flow-diagram.png

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    dc2ea1d View commit details
    Browse the repository at this point in the history

  9. polish cli descriptions

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    c286f35 View commit details
    Browse the repository at this point in the history

  10. small update in the Warning box

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    10be3d6 View commit details
    Browse the repository at this point in the history

  11. add sonobe naming

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    2682095 View commit details
    Browse the repository at this point in the history

  12. add folding-main-idea-diagram.png

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    f633072 View commit details
    Browse the repository at this point in the history

  13. missing sonobe renaming

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    ec3ff9f View commit details
    Browse the repository at this point in the history

  14. migrate part of the README.md to sonobe-docs

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    ec2f6dc View commit details
    Browse the repository at this point in the history

  15. rm imgs/, load them from sonobe-docs

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    c3454c1 View commit details
    Browse the repository at this point in the history

  16. tiny update

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    0013a10 View commit details
    Browse the repository at this point in the history

  17. chore: start update README

    @dmpierre @arnaucube
    dmpierre authored and arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    cfe9a68 View commit details
    Browse the repository at this point in the history

  18. add acknolwedgments links and text, small polishing of the overall text

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    509e3f3 View commit details
    Browse the repository at this point in the history

  19. extend folding introduction & sonobe overview

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    904d690 View commit details
    Browse the repository at this point in the history

  20. img text alignment

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    fd599a4 View commit details
    Browse the repository at this point in the history

  21. chore: update readme

    @dmpierre @arnaucube
    dmpierre authored and arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    4590cbc View commit details
    Browse the repository at this point in the history

  22. chore: typos, bits of reformulation, centering images

    @dmpierre @arnaucube
    dmpierre authored and arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    e0d0f5d View commit details
    Browse the repository at this point in the history

  23. chore: remove btc example since can not be used as is

    @dmpierre @arnaucube
    dmpierre authored and arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    0b8b34d View commit details
    Browse the repository at this point in the history

  24. rm .vscode dir

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    2111cf0 View commit details
    Browse the repository at this point in the history

  25. readme: merge the duplicated sections into a single one adapting the … 

    …texts
    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    e1988eb View commit details
    Browse the repository at this point in the history

  26. add Docs badge with link, update acknowledgments

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    7cd627d View commit details
    Browse the repository at this point in the history

  27. add ci & license badges

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    02b33d2 View commit details
    Browse the repository at this point in the history

  28. fix cli link, add solc mention in solidity-verifiers/readme

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    19b004d View commit details
    Browse the repository at this point in the history

  29. small polishing

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    7b282bd View commit details
    Browse the repository at this point in the history

  30. fix img alignment

    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    56efca0 View commit details
    Browse the repository at this point in the history

  31. rm badges, the reasoning is: 

    - The License badge is not needed since there are already many links to
  the license both in the readme and in the GitHub UI
- The CI checks badge, already appears in the GitHub UI in the last
  commit preview at the main repo page. Furthermore, after some months
  of inactivity, the badge would be 'gray' as 'inactive'.
- The only badge that I was trying to get there is the 'docs' badge, to
  make it very clear that the docs page exists, but it was a bit to hard
  visually to have a single badge there, and furthermore the docs link
  already appears in the readme twice, and also in the GitHub UI
  right-panel.
    @arnaucube
    arnaucube committed Apr 17, 2024
    Configuration menu
    Copy the full SHA
    5eef7cc View commit details
    Browse the repository at this point in the history