Browse Source

Update README

master
Pratyush Mishra 5 years ago
parent
commit
8da2ea6250
1 changed files with 5 additions and 2 deletions
  1. +5
    -2
      README.md

+ 5
- 2
README.md

@ -32,11 +32,14 @@ This repository contains several Rust crates that implement the different buildi
* [`algebra`](algebra): Rust crate that provides finite fields and elliptic curves * [`algebra`](algebra): Rust crate that provides finite fields and elliptic curves
* [`dpc`](dpc): Rust crate that implements DPC schemes (the main cryptographic primitive in this repository) * [`dpc`](dpc): Rust crate that implements DPC schemes (the main cryptographic primitive in this repository)
* [`snark`](snark): Rust crate that provides succinct zero-knowledge arguments
* [`snark-gadgets`](snark-gadgets): Rust crate that provides various gadgets used to construct constraint systems
* [`r1cs-core`](r1cs-core): Rust crate that defines core interfaces for a Rank-1 Constraint System (R1CS)
* [`r1cs-std`](r1cs-std): Rust crate that provides various gadgets used to construct R1CS
* [`gm17`](gm17): Rust crate that implements the zkSNARK of [Groth and Maller][GM17]
In addition, there is a [`bench-utils`](bench-utils) crate which contains infrastructure for benchmarking. This crate includes macros for timing code segments and is used for profiling the building blocks of ZEXE. In addition, there is a [`bench-utils`](bench-utils) crate which contains infrastructure for benchmarking. This crate includes macros for timing code segments and is used for profiling the building blocks of ZEXE.
[GM17]: https://ia.cr/2017/540
## Build guide ## Build guide
The library compiles on the `stable` toolchain of the Rust compiler. To install the latest version of Rust, first install `rustup` by following the instructions [here](https://rustup.rs/), or via your platform's package manager. Once `rustup` is installed, install the Rust toolchain by invoking: The library compiles on the `stable` toolchain of the Rust compiler. To install the latest version of Rust, first install `rustup` by following the instructions [here](https://rustup.rs/), or via your platform's package manager. Once `rustup` is installed, install the Rust toolchain by invoking:

Loading…
Cancel
Save