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

docs: add blitzar workaround #241

Merged
merged 1 commit into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
24 changes: 17 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

### <a name="fork-the-repository"></a> Fork the Repository
Expand Down Expand Up @@ -152,6 +145,23 @@ Before you submit your Pull Request (PR) consider the following guidelines:
cargo test --all-features
```

<details>
<summary>
Workaround for non-Linux and/or non-GPU machines.
</summary>

* 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"
```

</details>

5. <a name="code-quality-checks"></a>Run the following code quality checks locally so that the code is not only correct but also clean.

```shell
Expand Down
36 changes: 16 additions & 20 deletions crates/proof-of-sql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<!-- TDDO: add this in when we put it on crates.io
<details>
<summary>
Workaround for non-Linux and/or non-GPU machines.
</summary>

* 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 --all-targets
```
* 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"
```

</details>

### Setup

To use Proof of SQL, add it as a dependency in your `Cargo.toml` file:

```toml
[dependencies]
proof-of-sql = "x.x.x"
```

Replace `x.x.x` with the version number you want to use. You can now use Proof of SQL in your Rust project. Import the necessary modules using `proof-of-sql::prelude::*` and start using the library's features in your code:

```rust
use proof-of-sql::prelude::*;

fn main() {
// Your code here
}
```
-->

## Examples

Expand Down
Loading