Merge branch 'main' into test/dynamic-dory-tests

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.
 
 ### <a name="fork-the-repository"></a> Fork the Repository
@@ -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

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)
 
-<!-- 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