Skip to content

Commit

Permalink
Update README.md (#152)
Browse files Browse the repository at this point in the history
* Update README.md

Slight updates to the README to add a Contributors shield + some slight tidying up of languages / links

* Update README.md
  • Loading branch information
brunny-eth authored Sep 11, 2024
1 parent 636831e commit 031ec7d
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
<h1 align="center">
ronkathon
</h1>

<p align="center">
ronkathon
</p>

<div align="center">
<a href="https://github.com/pluto/ronkathon/actions">
<img src="https://github.com/pluto/ronkathon/actions/workflows/test.yaml/badge.svg" />
<img src="https://github.com/pluto/ronkathon/actions/workflows/lint.yaml/badge.svg" />
<a href="https://github.com/pluto/ronkathon/graphs/contributors">
<img src="https://img.shields.io/github/contributors/pluto/ronkathon?style=flat-square&logo=github&logoColor=8b949e&labelColor=282f3b&color=32c955" alt="Contributors" />
</a>
</div>
<a href="https://github.com/pluto/ronkathon/actions/workflows/test.yaml">
<img src="https://img.shields.io/badge/tests-passing-32c955?style=flat-square&logo=github-actions&logoColor=8b949e&labelColor=282f3b" alt="Tests" />
</a>
<a href="https://github.com/pluto/ronkathon/actions/workflows/lint.yaml">
<img src="https://img.shields.io/badge/lint-passing-32c955?style=flat-square&logo=github-actions&logoColor=8b949e&labelColor=282f3b" alt="Lint" />
</a>
</div>

## 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

Expand All @@ -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`

Expand Down Expand Up @@ -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

Expand All @@ -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.

0 comments on commit 031ec7d

Please sign in to comment.