give up and just document better

mwlon · Jul 6, 2024 · 3974d16 · 3974d16
1 parent a29c5bc
commit 3974d16
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 35 deletions.
diff --git a/pco/Cargo.toml b/pco/Cargo.toml
@@ -2,7 +2,6 @@
 name = "pco"
 version = "0.3.0"
 edition = "2021"
-build = "build.rs"
 
 authors = ["mwlon <m.w.loncaric@gmail.com>"]
 categories = ["compression", "encoding"]
@@ -20,6 +19,3 @@ rand_xoshiro = { version = "0.6.0" }
 
 [dev-dependencies]
 rand = "0.8.4"
-
-[features]
-recommended-instruction-sets = []
diff --git a/pco/README.md b/pco/README.md
@@ -33,8 +33,7 @@ Almost all hardware x86 hardware these days supports `bmi1`, `bmi2`, and `avx2`.
 This improves compression speed slightly and decompression speed substantially!
 To make sure you're using these, you can:
 
-* Use this crate's `recommended-instruction-sets` feature,
-* OR Add the following to your `~/.cargo/config.toml`:
+* Add the following to your `~/.cargo/config.toml`:
 ```toml
 [target.'cfg(target_arch = "x86_64")']
 rustflags = ["-C", "target-feature=+bmi1,+bmi2,+avx2"]

diff --git a/pco/build.rs b/pco/build.rs
diff --git a/pco_cli/Cargo.toml b/pco_cli/Cargo.toml
@@ -30,7 +30,7 @@ parquet = { version = "49.0.0", features = [
   "snap",
   "zstd",
 ], default-features = false }
-pco = { version = "0.3", path = "../pco", features = ["recommended-instruction-sets"] }
+pco = { version = "0.3", path = "../pco" }
 q_compress = { version = "0.11.7", path = "../quantile-compression/q_compress", optional = true }
 snap = "1.1.0"
 spdp_sys = { version = "0.1", optional = true }

diff --git a/pco_cli/README.md b/pco_cli/README.md
@@ -6,11 +6,12 @@
 
 # Setup
 
-You can compress, decompress, and inspect standalone .pco files using the CLI.
+You can compress, decompress, inspect, and benchmark standalone .pco files using the CLI.
 Follow this setup:
 
 1. Install Rust: https://www.rust-lang.org/tools/install
-2. `cargo install pco_cli`
+2. (optional but recommended for best performance on x86) [Configure the instruction sets available](../pco/README.md#compilation-notes)
+3. `cargo install pco_cli`
 
 This provides you with the `pcodec` command.