From 6daaefb5c9b71e4a8aa14b1b0564a1d547e80227 Mon Sep 17 00:00:00 2001
From: Rigidity <35380458+Rigidity@users.noreply.github.com>
Date: Mon, 16 Sep 2024 13:59:10 -0400
Subject: [PATCH] Consolidate wheel readme into main (#465)

---
 README.md        | 37 ++++++++++++++++++++++++++++++++++++-
 wheel/Cargo.toml |  2 +-
 wheel/README.md  | 34 ----------------------------------
 3 files changed, 37 insertions(+), 36 deletions(-)
 delete mode 100644 wheel/README.md

diff --git a/README.md b/README.md
index f41dcd90..c2254cf4 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ The cargo workspace includes an rlib crate, for use with rust or other applicati
 
 The python wheel is in `wheel`. The npm package is in `wasm`.
 
-## TESTS
+## Tests
 
 In order to run the unit tests, run:
 
@@ -34,3 +34,38 @@ cargo fuzz run fuzz_run_program --jobs=32 -- -rss_limit_mb=4096
 But with whatever number of jobs works best for you.
 
 If you find issues in `clvm_rs` please use our [bug bounty program](https://hackerone.com/chia_network).
+
+## Build Wheel
+
+The `clvm_rs` wheel has python bindings for the rust implementation of clvm.
+
+Use `maturin` to build the python interface. First, install into current virtualenv with
+
+```
+$ pip install maturin
+```
+
+While in the `wheel` directory, build `clvm_rs` into the current virtualenv with
+
+```
+$ maturin develop --release
+```
+
+On UNIX-based platforms, you may get a speed boost on `sha256` operations by building
+with OpenSSL.
+
+```
+$ maturin develop --release --features=openssl
+```
+
+To build the wheel, do
+
+```
+$ maturin build --release
+```
+
+or
+
+```
+$ maturin build --release --features=openssl
+```
diff --git a/wheel/Cargo.toml b/wheel/Cargo.toml
index 173a290c..56729e61 100644
--- a/wheel/Cargo.toml
+++ b/wheel/Cargo.toml
@@ -7,7 +7,7 @@ license = "Apache-2.0"
 description = "Implementation of `clvm` for Chia Network's cryptocurrency"
 homepage = "https://github.com/Chia-Network/clvm_rs/"
 repository = "https://github.com/Chia-Network/clvm_rs/"
-readme = "README.md"
+readme = "../README.md"
 
 [lib]
 name = "clvm_rs"
diff --git a/wheel/README.md b/wheel/README.md
deleted file mode 100644
index f57faf55..00000000
--- a/wheel/README.md
+++ /dev/null
@@ -1,34 +0,0 @@
-The `clvm_rs` wheel has python bindings for the rust implementation of clvm.
-
-## Build
-
-Use `maturin` to build the python interface. First, install into current virtualenv with
-
-```
-$ pip install maturin
-```
-
-While in the `wheel` directory, build `clvm_rs` into the current virtualenv with
-
-```
-$ maturin develop --release
-```
-
-On UNIX-based platforms, you may get a speed boost on `sha256` operations by building
-with OpenSSL.
-
-```
-$ maturin develop --release --features=openssl
-```
-
-To build the wheel, do
-
-```
-$ maturin build --release
-```
-
-or
-
-```
-$ maturin build --release --features=openssl
-```