Include README in Cargo.toml (#936)

spiraldb · Sep 26, 2024 · 06879bc · 06879bc
1 parent b73e6b8
commit 06879bc
Show file tree

Hide file tree

Showing 31 changed files with 48 additions and 8 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -39,6 +39,7 @@ include = [
 ]
 edition = "2021"
 rust-version = "1.81"
+readme = "README.md"
 
 [workspace.dependencies]
 libfuzzer-sys = "0.4"

diff --git a/bench-vortex/Cargo.toml b/bench-vortex/Cargo.toml
@@ -11,6 +11,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = "README.md"
 
 [lints.rust]
 warnings = "deny"

diff --git a/encodings/alp/Cargo.toml b/encodings/alp/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [lints]
 workspace = true

diff --git a/encodings/bytebool/Cargo.toml b/encodings/bytebool/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [lints]
 workspace = true

diff --git a/encodings/datetime-parts/Cargo.toml b/encodings/datetime-parts/Cargo.toml
@@ -2,8 +2,15 @@
 name = "vortex-datetime-parts"
 description = "Vortex physical encoding that compresses temporal components individually"
 version = { workspace = true }
-edition = "2021"
+homepage = { workspace = true }
+repository = { workspace = true }
+authors = { workspace = true }
 license = { workspace = true }
+keywords = { workspace = true }
+include = { workspace = true }
+edition = { workspace = true }
+rust-version = { workspace = true }
+readme = { workspace = true }
 
 [lints]
 workspace = true

diff --git a/encodings/dict/Cargo.toml b/encodings/dict/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [dependencies]
 ahash = { workspace = true }

diff --git a/encodings/fastlanes/Cargo.toml b/encodings/fastlanes/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [lints]
 workspace = true

diff --git a/encodings/fsst/Cargo.toml b/encodings/fsst/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = "README.md"
 
 [lints]
 workspace = true

diff --git a/encodings/roaring/Cargo.toml b/encodings/roaring/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [dependencies]
 arrow-buffer = { workspace = true }

diff --git a/encodings/runend-bool/Cargo.toml b/encodings/runend-bool/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [dependencies]
 arrow-buffer = { workspace = true }

diff --git a/encodings/runend/Cargo.toml b/encodings/runend/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [dependencies]
 itertools = { workspace = true }

diff --git a/encodings/zigzag/Cargo.toml b/encodings/zigzag/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [dependencies]
 serde = { workspace = true, features = ["derive"] }

diff --git a/fuzz/Cargo.toml b/fuzz/Cargo.toml
@@ -1,9 +1,18 @@
 [package]
 name = "vortex-fuzz"
-version = "0.0.0"
 publish = false
-edition = { workspace = true }
+description = "Fuzzer for vortex arrays"
+version = { workspace = true }
+homepage = { workspace = true }
+repository = { workspace = true }
+authors = { workspace = true }
 license = { workspace = true }
+keywords = { workspace = true }
+include = { workspace = true }
+edition = { workspace = true }
+rust-version = { workspace = true }
+readme = "README.md"
+
 
 [package.metadata]
 cargo-fuzz = true

diff --git a/pyvortex/pyproject.toml b/pyvortex/pyproject.toml
@@ -2,7 +2,7 @@
 name = "vortex-array"
 # Maturin copies these, at build time, from Cargo.toml.
 # https://github.com/PyO3/maturin/blob/main/src/metadata.rs#L127-L129
-dyanmic = ["version", "description", "authors"]
+dynamic = ["version", "description", "authors"]
 readme = "README.md"
 dependencies = [
     "pyarrow>=15.0.0",

diff --git a/vortex-array/Cargo.toml b/vortex-array/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [lib]
 name = "vortex"

diff --git a/vortex-array/README.md b/vortex-array/README.md
diff --git a/vortex-buffer/Cargo.toml b/vortex-buffer/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = "README.md"
 
 [features]
 flexbuffers = ["dep:flexbuffers"]

diff --git a/vortex-datafusion/Cargo.toml b/vortex-datafusion/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [lib]
 name = "vortex_datafusion"

diff --git a/vortex-datetime-dtype/Cargo.toml b/vortex-datetime-dtype/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [dependencies]
 arrow-schema = { workspace = true, optional = true }

diff --git a/vortex-dtype/Cargo.toml b/vortex-dtype/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [lib]
 name = "vortex_dtype"

diff --git a/vortex-error/Cargo.toml b/vortex-error/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [lib]
 name = "vortex_error"

diff --git a/vortex-expr/Cargo.toml b/vortex-expr/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = "README.md"
 
 [lib]
 name = "vortex_expr"

diff --git a/vortex-flatbuffers/Cargo.toml b/vortex-flatbuffers/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = "README.md"
 
 [features]
 dtype = []

diff --git a/vortex-flatbuffers/README.md b/vortex-flatbuffers/README.md
@@ -3,7 +3,6 @@
 This crate contains Flatbuffers definitions that can be used to convert other crates in this workspace back
 and forth into Flatbuffers messages.
 
-
 ## Regenerating the bindings
 
-Run the `./regen.sh` script. Be sure that you have the `flatc` utility installed before doing so.
+Run the `cargo xtask generate-fbs` script. Be sure that you have the `flatc` utility installed before doing so.
diff --git a/vortex-proto/Cargo.toml b/vortex-proto/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [dependencies]
 prost = { workspace = true }

diff --git a/vortex-sampling-compressor/Cargo.toml b/vortex-sampling-compressor/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [dependencies]
 arbitrary = { workspace = true, optional = true }

diff --git a/vortex-scalar/Cargo.toml b/vortex-scalar/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [dependencies]
 arbitrary = { workspace = true, optional = true }

diff --git a/vortex-schema/Cargo.toml b/vortex-schema/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = { workspace = true }
 
 [dependencies]
 vortex-dtype = { workspace = true }

diff --git a/vortex-serde/Cargo.toml b/vortex-serde/Cargo.toml
@@ -10,6 +10,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = "README.md"
 
 [dependencies]
 ahash = { workspace = true }

diff --git a/xtask/Cargo.toml b/xtask/Cargo.toml
@@ -2,6 +2,7 @@
 name = "xtask"
 # This is an internal crate for project developers
 publish = false
+description = "Tasks for repo management"
 version = { workspace = true }
 homepage = { workspace = true }
 repository = { workspace = true }
@@ -11,6 +12,7 @@ keywords = { workspace = true }
 include = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
+readme = "README.md"
 
 [dependencies]
 anyhow = { workspace = true }