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.

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

docs: update README #4

Merged
merged 6 commits into from
Jun 5, 2024
Merged

docs: update README #4

merged 6 commits into from
Jun 5, 2024

Conversation

johnchandlerburnham
Copy link
Member

@johnchandlerburnham johnchandlerburnham commented May 31, 2024

Updates the README for Sphinx, with particular focus on the acknowledgements.

@johnchandlerburnham johnchandlerburnham changed the title WIP: update README WIP: docs: update README May 31, 2024
@johnchandlerburnham johnchandlerburnham changed the title WIP: docs: update README docs: update README May 31, 2024
Copy link
Contributor

@huitseeker huitseeker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sphinx.jpg is a photo by Konsta Punkka, I have not found indications that it is free of rights, is that the case?
Sphinx2.jpg is on various stock photo sites, did we purchase a license for it? considering I'm still seeing the watermark from vecteezy, I'd assume not?

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@huitseeker huitseeker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly typos by now.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
with work from Risc Zero, Valida, Polygon and others to create an excellent
packaged developer experience. Sphinx is a fork of SP1
- [Risc Zero](https://www.risczero.com/), who developed and maintain the
[riscv32im-risc0-zkvm-elf](https://doc.rust-lang.org/nightly/rustc/platform-support/riscv32im-risc0-zkvm-elf.html)
Copy link
Contributor

@huitseeker huitseeker Jun 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So technically this isn't what SP1/Sphinx is using: as the name of every compiled SP1 program indicates, it has its own riscv32im-succinct-zkvm-elf target (notice 'succinct'), which clones Risc0's process for defining (and using) a custom RiscV compilation target, but does not reuse the outcome of that process (and those credits for maintenance kinda suggest that Sphinx does).

Copy link
Member Author

@johnchandlerburnham johnchandlerburnham Jun 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, what about

  • Risc Zero, who developed and maintain the riscv32im-risc0-zkvm-elf Rust toolchain, from which the riscv32im-succinct-zkvm-elf toolchain used by SP1 and Sphinx are derived.

Or something like that?

Co-authored-by: François Garillot <4142+huitseeker@users.noreply.github.com>
@johnchandlerburnham johnchandlerburnham merged commit 8a399cc into dev Jun 5, 2024
6 checks passed
@johnchandlerburnham johnchandlerburnham deleted the jcb/readme branch June 5, 2024 14:42
huitseeker added a commit that referenced this pull request Jun 12, 2024
# This is the 1st commit message:

chore: clippy

# The commit message #2 will be skipped:

# fixup! feat: exit code (#750)

# The commit message #3 will be skipped:

# fixup! feat: exit code (#750)

# The commit message #4 will be skipped:

# fixup! feat: exit code (#750)

# The commit message #5 will be skipped:

# fixup! feat: exit code (#750)
huitseeker added a commit that referenced this pull request Jun 13, 2024
# This is the 1st commit message:

chore: clippy

# The commit message #2 will be skipped:

# fixup! feat: exit code (#750)

# The commit message #3 will be skipped:

# fixup! feat: exit code (#750)

# The commit message #4 will be skipped:

# fixup! feat: exit code (#750)

# The commit message #5 will be skipped:

# fixup! feat: exit code (#750)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants