From 031ec7dc39258a1bd0f98835b75748fc7732a68d Mon Sep 17 00:00:00 2001 From: brunny <96834997+brunny-eth@users.noreply.github.com> Date: Wed, 11 Sep 2024 10:42:13 -0400 Subject: [PATCH] Update README.md (#152) * Update README.md Slight updates to the README to add a Contributors shield + some slight tidying up of languages / links * Update README.md --- README.md | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 21038312..f0058a6e 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@

ronkathon

- -

- ronkathon -

-
- - - + + Contributors -
+ + Tests + + + Lint + + ## Overview -Ronkathon is a rust implementation of a collection of cryptographic primitives. It is inspired by the common python plonkathon repository, and plonk-by-hand. We use the same curve and field as plonk-by-hand (not secure), and are working towards building everything from scratch to understand everything from first principles. +Ronkathon is a collection of cryptographic primitives implemented in Rust. It is inspired by the [python plonkathon repository](https://github.com/0xPARC/plonkathon) and [plonk-by-hand](https://research.metastate.dev/plonk-by-hand-part-1/). We use the same curve and field as plonk-by-hand (which is not secure) and the goal of this repository is to work towards building everything from scratch to understand everything from first principles. ## Multivariate polynomials and sum-check @@ -26,7 +26,7 @@ This project implements the sum-check protocol for multivariate polynomials over - A `SumCheckVerifier` for verifying proofs - A `SumCheck` struct that encapsulates the entire protocol. -Use +You can use: `cargo run --example sumcheck_ex` @@ -72,6 +72,7 @@ We have found the following resources helpful in understanding the foundational - [Plonk by Hand P1](https://research.metastate.dev/plonk-by-hand-part-1/) - [Plonk by Hand P2](https://research.metastate.dev/plonk-by-hand-part-2-the-proof/) +- [Plonk by Hand P3](https://research.metastate.dev/plonk-by-hand-part-3-verification/) ### Code Refrences @@ -86,15 +87,17 @@ To see computations used in the background, go to the `math/` directory. From there, you can run the `.sage` files in a SageMath environment. In particular, the `math/field.sage` computes roots of unity in the `PlutoField` which is of size 101. To install sage on your machine, follow the instructions [here](https://doc.sagemath.org/html/en/installation/index.html). If you are on a Mac, you can install it via homebrew with `brew install --cask sage`. +## Contributing + +We welcome contributions to our open-source projects. If you want to contribute or follow along with contributor discussions, join our [main Telegram channel](https://t.me/pluto_xyz/1) to chat about Pluto's development. + +Our contributor guidelines can be found in [CONTRIBUTING.md](./CONTRIBUTING.md). A good starting point is issues labelled 'bounty' in our repositories. + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. + ## License Licensed under your option of either: - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) - MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -## Contribution - -Unless you explicitly state otherwise, any contribution intentionally submitted -for inclusion in the work by you, as defined in the Apache-2.0 license, shall be -dual licensed as above, without any additional terms or conditions.