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

Update README.md #152

Merged
merged 2 commits into from
Jul 31, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,8 @@

_This project is under active development. For questions, please join us at [Threshold Network Discord](https://discord.com/invite/threshold&ved=2ahUKEwivucaW2Y3-AhXiwosKHQCEAKUQFnoECA0QAQ&usg=AOvVaw08x-9JYJFDcd6PEOx0xAeg)_

_See original README.md below_

## Testing

```bash
cargo test --no-default-features
```

---

# Ferveo

A synchronous Distributed Key Generation protocol for front-running protection on public blockchains.

## About
Expand All @@ -39,15 +29,21 @@ A preprint paper describing the construction of Ferveo and the novel cryptosyste

## Build

A Rust toolchain with version `>= 1.53.0` is required. In the future, Ferveo will target the `stable` toolchain.
A Rust toolchain with version `>= 1.65.0` is required. In the future, Ferveo will target the `stable` toolchain.
Installation via [rustup](https://rustup.rs/) is recommended.

Run `cargo build --release` to build.
Please note that performance may be significantly poorer when compiling in `Debug` mode.

## Testing

Run `cargo test --release` to run tests. Please note that performance may be significantly poorer when testing

```bash

```


cygnusv marked this conversation as resolved.
Show resolved Hide resolved
Run `cargo test --no-default-features --release` to run tests. Please note that performance may be significantly poorer when testing
in `Debug` mode.

## Benchmarks
Expand Down