From 8559eaf2ff011c25d3f82417a0c810fb2a33a9eb Mon Sep 17 00:00:00 2001
From: clabby <ben@clab.by>
Date: Thu, 21 Sep 2023 23:23:29 -0400
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20README=20+=20test=20env=20overfl?=
 =?UTF-8?q?ow=20checks?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .github/workflows/ci.yaml |  2 +-
 Cargo.toml                |  4 ++++
 README.md                 | 28 +++++++++++++++++++++++++++-
 3 files changed, 32 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index ed50d34..2015ba6 100644
--- a/.github/workflows/ci.yaml
+++ b/.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
diff --git a/Cargo.toml b/Cargo.toml
index 50c2714..5a8c703 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -5,3 +5,7 @@ resolver = "2"
 [workspace.package]
 version = "0.1.0"
 authors = ["clabby"]
+
+[profile.dev]
+opt-level = 1
+overflow-checks = false
diff --git a/README.md b/README.md
index f295bd7..efad54d 100644
--- a/README.md
+++ b/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/