📝 README + test env overflow checks

.github/workflows/ci.yaml

@@ -18,7 +18,7 @@ jobs:
         with:
           cache-on-failure: true
       - name: cargo test
-        run: cargo test --all --all-features --release
+        run: cargo test --all --all-features
   cargo-lint:
     runs-on: ubuntu-latest
     timeout-minutes: 20

Cargo.toml

@@ -5,3 +5,7 @@ resolver = "2"
 [workspace.package]
 version = "0.1.0"
 authors = ["clabby"]
+
+[profile.dev]
+opt-level = 1
+overflow-checks = false

README.md

@@ -22,11 +22,33 @@ credits for the original idea and reference implementation of this concept go to
 
 ## Contributing
 
+To get started, a few dependencies are required:
+* [Rust toolchain][rustup]
+    * Recommended: [`cargo-nextest`][nextest]
+* [Go toolchain][golang]
+* [binutils][binutils]
+
+### Testing
+
+```sh
+# With `cargo-nextest`
+cargo nextest run --all --all-features
+# Without `cargo-nextest`
+cargo t --all --all-features
+```
+
+### Linting and Formatting
+
+```sh
+cargo +nightly fmt -- && cargo +nightly clippy --all --all-features -- -D warnings
+```
+
+### Running Benchmarks
 *todo*
 
 ## Documentation
 
-*todo*
+Rustdocs are available by running `cargo doc --open` after cloning the repo.
 
 ## Docker
 
@@ -35,3 +57,7 @@ credits for the original idea and reference implementation of this concept go to
 [geohot]: https://github.com/geohot
 [op-labs]: https://oplabs.co
 [cannon]: https://github.com/ethereum-optimism/optimism/tree/develop/cannon
+[rustup]: https://rustup.rs/
+[golang]: https://go.dev/doc/install
+[binutils]: https://www.gnu.org/software/binutils/
+[nextest]: https://nexte.st/