Cargo.toml polishing

ciaranra · ciaranra · commit c3e7e976089d · 2026-01-06T15:58:29.000-07:00
diff --git a/crates/benchmarks/Cargo.toml b/crates/benchmarks/Cargo.toml
@@ -9,7 +9,8 @@ license.workspace = true
 keywords.workspace = true
 categories.workspace = true
 publish = false
-readme = "../../README.md"
+description = "Performance benchmarks for PECOS (internal)"
+readme = "README.md"
 
 [dev-dependencies]
 criterion.workspace = true
diff --git a/crates/pecos-build/Cargo.toml b/crates/pecos-build/Cargo.toml
@@ -3,7 +3,7 @@ name = "pecos-build"
 version.workspace = true
 edition.workspace = true
 description = "PECOS build utilities - dependency management, LLVM setup, and build script helpers"
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
diff --git a/crates/pecos-chromobius/Cargo.toml b/crates/pecos-chromobius/Cargo.toml
@@ -2,14 +2,14 @@
 name = "pecos-chromobius"
 version.workspace = true
 edition.workspace = true
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "Chromobius decoder wrapper for PECOS"
+description = "Chromobius color code decoder for PECOS"
 
 [dependencies]
 pecos-decoder-core.workspace = true
diff --git a/crates/pecos-core/Cargo.toml b/crates/pecos-core/Cargo.toml
@@ -8,8 +8,8 @@ repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "Provides core definitions and functions for PECOS simulations."
-readme = "../../README.md"
+description = "Core types and utilities for PECOS"
+readme = "README.md"
 
 [dependencies]
 bitvec.workspace = true
diff --git a/crates/pecos-decoder-core/Cargo.toml b/crates/pecos-decoder-core/Cargo.toml
@@ -2,7 +2,7 @@
 name = "pecos-decoder-core"
 version.workspace = true
 edition.workspace = true
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
diff --git a/crates/pecos-decoders/Cargo.toml b/crates/pecos-decoders/Cargo.toml
@@ -2,14 +2,14 @@
 name = "pecos-decoders"
 version.workspace = true
 edition.workspace = true
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "Unified decoder library for PECOS - meta crate"
+description = "Unified decoder meta-crate for PECOS"
 
 [dependencies]
 pecos-decoder-core.workspace = true
diff --git a/crates/pecos-engines/Cargo.toml b/crates/pecos-engines/Cargo.toml
@@ -2,14 +2,14 @@
 name = "pecos-engines"
 version.workspace = true
 edition.workspace = true
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "Provides simulator engines for PECOS simulations."
+description = "Simulation engine infrastructure for PECOS"
 
 [lib]
 crate-type = ["rlib"]
diff --git a/crates/pecos-fusion-blossom/Cargo.toml b/crates/pecos-fusion-blossom/Cargo.toml
@@ -2,14 +2,14 @@
 name = "pecos-fusion-blossom"
 version.workspace = true
 edition.workspace = true
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "Fusion Blossom decoder wrapper for PECOS"
+description = "Fusion Blossom MWPM decoder for PECOS"
 
 [dependencies]
 pecos-decoder-core.workspace = true
diff --git a/crates/pecos-hugr-qis/Cargo.toml b/crates/pecos-hugr-qis/Cargo.toml
@@ -8,7 +8,7 @@ repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "HUGR to QIS (Quantum Instruction Set) compiler for PECOS quantum programs."
+description = "HUGR to QIS compiler for PECOS"
 readme = "README.md"
 
 [dependencies]
diff --git a/crates/pecos-hugr/Cargo.toml b/crates/pecos-hugr/Cargo.toml
@@ -2,7 +2,7 @@
 name = "pecos-hugr"
 version.workspace = true
 edition.workspace = true
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
diff --git a/crates/pecos-ldpc-decoders/Cargo.toml b/crates/pecos-ldpc-decoders/Cargo.toml
@@ -2,7 +2,7 @@
 name = "pecos-ldpc-decoders"
 version.workspace = true
 edition.workspace = true
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
diff --git a/crates/pecos-llvm/Cargo.toml b/crates/pecos-llvm/Cargo.toml
@@ -3,7 +3,7 @@ name = "pecos-llvm"
 version.workspace = true
 edition.workspace = true
 description = "Rust wrapper for LLVM IR generation using inkwell"
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
diff --git a/crates/pecos-num/Cargo.toml b/crates/pecos-num/Cargo.toml
@@ -8,8 +8,8 @@ repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-readme.workspace = true
-description = "Numerical computing support for PECOS quantum error correction simulations"
+readme = "README.md"
+description = "Numerical computing support for PECOS"
 
 [dependencies]
 # Linear algebra (for polynomial fitting, curve fitting, matrix operations)
diff --git a/crates/pecos-phir/Cargo.toml b/crates/pecos-phir/Cargo.toml
@@ -9,7 +9,7 @@ repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "PECOS High-level Intermediate Representation (PHIR) pipeline for quantum program compilation and execution."
+description = "MLIR-inspired quantum program intermediate representation for PECOS"
 
 [dependencies]
 # Core PECOS dependencies
diff --git a/crates/pecos-pymatching/Cargo.toml b/crates/pecos-pymatching/Cargo.toml
@@ -2,14 +2,14 @@
 name = "pecos-pymatching"
 version.workspace = true
 edition.workspace = true
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "PyMatching decoder wrapper for PECOS"
+description = "PyMatching MWPM decoder for PECOS"
 
 [dependencies]
 pecos-decoder-core.workspace = true
diff --git a/crates/pecos-qasm/Cargo.toml b/crates/pecos-qasm/Cargo.toml
@@ -2,14 +2,14 @@
 name = "pecos-qasm"
 version.workspace = true
 edition.workspace = true
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "QASM parser and engine for PECOS quantum simulator"
+description = "OpenQASM 2.0 parser and execution engine for PECOS"
 
 [features]
 default = ["wasm"]
diff --git a/crates/pecos-qec/Cargo.toml b/crates/pecos-qec/Cargo.toml
@@ -8,8 +8,8 @@ repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "QEC for Rust PECOS."
-readme = "../../README.md"
+description = "Quantum error correction utilities for PECOS"
+readme = "README.md"
 
 [lints]
 workspace = true
diff --git a/crates/pecos-qis-ffi-types/Cargo.toml b/crates/pecos-qis-ffi-types/Cargo.toml
@@ -3,7 +3,7 @@ name = "pecos-qis-ffi-types"
 version.workspace = true
 edition.workspace = true
 description = "Data structures for quantum instruction set FFI operations"
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
diff --git a/crates/pecos-qis-ffi/Cargo.toml b/crates/pecos-qis-ffi/Cargo.toml
@@ -3,7 +3,7 @@ name = "pecos-qis-ffi"
 version.workspace = true
 edition.workspace = true
 description = "FFI layer for quantum instruction set operations"
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
diff --git a/crates/pecos-qis/Cargo.toml b/crates/pecos-qis/Cargo.toml
@@ -3,7 +3,7 @@ name = "pecos-qis"
 version.workspace = true
 edition.workspace = true
 description = "Quantum instruction set (QIS) infrastructure and Selene runtime for PECOS"
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
diff --git a/crates/pecos-qsim/Cargo.toml b/crates/pecos-qsim/Cargo.toml
@@ -8,8 +8,8 @@ repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "Provides simulators and related elements for PECOS simulations."
-readme = "../../README.md"
+description = "Quantum simulator traits and implementations for PECOS"
+readme = "README.md"
 
 [dependencies]
 pecos-core.workspace = true
diff --git a/crates/pecos-quantum/Cargo.toml b/crates/pecos-quantum/Cargo.toml
@@ -8,8 +8,8 @@ repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "Quantum computing primitives for PECOS, including DagCircuit."
-readme = "../../README.md"
+description = "Quantum circuit representation data structures for PECOS"
+readme = "README.md"
 
 [dependencies]
 pecos-core.workspace = true
diff --git a/crates/pecos-quest/Cargo.toml b/crates/pecos-quest/Cargo.toml
@@ -2,7 +2,7 @@
 name = "pecos-quest"
 version.workspace = true
 edition.workspace = true
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
diff --git a/crates/pecos-qulacs/Cargo.toml b/crates/pecos-qulacs/Cargo.toml
@@ -9,7 +9,7 @@ license.workspace = true
 keywords.workspace = true
 categories.workspace = true
 description = "Qulacs quantum simulator bindings for PECOS"
-readme.workspace = true
+readme = "README.md"
 
 [dependencies]
 pecos-core.workspace = true
diff --git a/crates/pecos-rng/Cargo.toml b/crates/pecos-rng/Cargo.toml
@@ -2,14 +2,14 @@
 name = "pecos-rng"
 version.workspace = true
 edition.workspace = true
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "Random number generators for PECOS quantum computing simulations"
+description = "Random number generation for PECOS"
 
 [dependencies]
 wide.workspace = true
diff --git a/crates/pecos-tesseract/Cargo.toml b/crates/pecos-tesseract/Cargo.toml
@@ -2,14 +2,14 @@
 name = "pecos-tesseract"
 version.workspace = true
 edition.workspace = true
-readme.workspace = true
+readme = "README.md"
 authors.workspace = true
 homepage.workspace = true
 repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-description = "Tesseract decoder wrapper for PECOS"
+description = "Tesseract search-based decoder for PECOS"
 
 [dependencies]
 pecos-decoder-core.workspace = true
diff --git a/crates/pecos-wasm/Cargo.toml b/crates/pecos-wasm/Cargo.toml
@@ -1,14 +1,3 @@
-# Copyright 2025 The PECOS Developers
-#
-# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
-# specific language governing permissions and limitations under the License.
-
 [package]
 name = "pecos-wasm"
 version.workspace = true
diff --git a/crates/pecos/Cargo.toml b/crates/pecos/Cargo.toml
@@ -8,8 +8,8 @@ repository.workspace = true
 license.workspace = true
 keywords.workspace = true
 categories.workspace = true
-readme = "../../README.md"
-description = "A crate for evaluating and exploring quantum error correction."
+readme = "README.md"
+description = "Main PECOS metacrate providing unified access to quantum simulation and error correction"
 # Disable auto-discovery of binaries (we only want pecos binary, not engine_setup helper module)
 autobins = false
 
