diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 50589c07..8e80a76e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,13 +65,6 @@ To contribute to this project, you'll need to have Rust installed on your machin rustup component add clippy ``` -6. Start building. - - With Rust installed, you're now ready to start developing! You can create a new project by running: - ```bash - cargo new my_project - cd my_project - ``` - If you run into any issues, please refer to the [official Rust documentation](https://www.rust-lang.org/learn/get-started) for troubleshooting and more detailed installation instructions. ### Fork the Repository @@ -152,6 +145,23 @@ Before you submit your Pull Request (PR) consider the following guidelines: cargo test --all-features ``` +
+ + Workaround for non-Linux and/or non-GPU machines. + + + * Workaround #1: enable the CPU version of Blitzar by setting the `BLITZAR_BACKEND` environment variable. Example: + ```bash + export BLITZAR_BACKEND=cpu + cargo test --all-features + ``` + * Workaround #2: disable the `blitzar` feature in the repo. Example + ```bash + cargo test --no-default-features --features="arrow rayon ark-ec/parallel ark-poly/parallel ark-ff/asm" + ``` + +
+ 5. Run the following code quality checks locally so that the code is not only correct but also clean. ```shell diff --git a/crates/proof-of-sql/README.md b/crates/proof-of-sql/README.md index 270458ab..be1254a6 100644 --- a/crates/proof-of-sql/README.md +++ b/crates/proof-of-sql/README.md @@ -37,27 +37,23 @@ Get started with Proof of SQL by using the published crate on [crates.io](https: * clang (`sudo apt install clang`) * [Rust 1.81.0](https://www.rust-lang.org/tools/install) - ## Examples