chore(code): Add path to README to all crates

informalsystems · Dec 18, 2024 · 301261f · 301261f
1 parent 3a1bc32
commit 301261f
Show file tree

Hide file tree

Showing 20 changed files with 70 additions and 6 deletions.
diff --git a/code/Cargo.toml b/code/Cargo.toml
@@ -41,6 +41,7 @@ members = [
 [workspace.package]
 version      = "0.0.1"
 edition      = "2021"
+readme       = "README.md"
 repository   = "https://github.com/informalsystems/malachite"
 license      = "Apache-2.0"
 publish      = true

diff --git a/code/crates/app-channel/Cargo.toml b/code/crates/app-channel/Cargo.toml
@@ -6,6 +6,10 @@ repository.workspace = true
 license.workspace = true
 publish.workspace = true
 rust-version.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [dependencies]
 bytes.workspace = true

diff --git a/code/crates/app/Cargo.toml b/code/crates/app/Cargo.toml
@@ -6,6 +6,10 @@ repository.workspace = true
 license.workspace = true
 publish.workspace = true
 rust-version.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [dependencies]
 malachitebft-engine.workspace = true

diff --git a/code/crates/codec/Cargo.toml b/code/crates/codec/Cargo.toml
@@ -6,6 +6,10 @@ repository.workspace = true
 license.workspace = true
 publish.workspace = true
 rust-version.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [dependencies]
 bytes.workspace = true

diff --git a/code/crates/config/Cargo.toml b/code/crates/config/Cargo.toml
@@ -8,6 +8,10 @@ repository.workspace = true
 license.workspace = true
 publish.workspace = true
 rust-version.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [lints]
 workspace = true

diff --git a/code/crates/core-consensus/Cargo.toml b/code/crates/core-consensus/Cargo.toml
@@ -6,6 +6,10 @@ repository.workspace = true
 license.workspace = true
 publish.workspace = true
 rust-version.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [features]
 std = []

diff --git a/code/crates/core-driver/Cargo.toml b/code/crates/core-driver/Cargo.toml
@@ -8,6 +8,10 @@ repository.workspace = true
 license.workspace = true
 publish.workspace = true
 rust-version.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [features]
 std = ["malachitebft-core-state-machine/std"]

diff --git a/code/crates/core-state-machine/Cargo.toml b/code/crates/core-state-machine/Cargo.toml
@@ -8,6 +8,10 @@ repository.workspace = true
 license.workspace = true
 publish.workspace = true
 rust-version.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [dependencies]
 malachitebft-core-types = { workspace = true }

diff --git a/code/crates/core-types/Cargo.toml b/code/crates/core-types/Cargo.toml
@@ -8,6 +8,10 @@ repository.workspace = true
 license.workspace = true
 publish.workspace = true
 rust-version.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [lints]
 workspace = true

diff --git a/code/crates/core-votekeeper/Cargo.toml b/code/crates/core-votekeeper/Cargo.toml
@@ -8,6 +8,10 @@ repository.workspace = true
 license.workspace = true
 publish.workspace = true
 rust-version.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [dependencies]
 malachitebft-core-types = { workspace = true }

diff --git a/code/crates/discovery/Cargo.toml b/code/crates/discovery/Cargo.toml
@@ -5,6 +5,10 @@ edition.workspace = true
 repository.workspace = true
 license.workspace = true
 publish.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [lints]
 workspace = true

diff --git a/code/crates/engine/Cargo.toml b/code/crates/engine/Cargo.toml
@@ -6,6 +6,10 @@ repository.workspace = true
 license.workspace = true
 rust-version.workspace = true
 publish.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [lints]
 workspace = true

diff --git a/code/crates/metrics/Cargo.toml b/code/crates/metrics/Cargo.toml
@@ -6,6 +6,10 @@ repository.workspace = true
 license.workspace = true
 publish.workspace = true
 rust-version.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [dependencies]
 malachitebft-core-state-machine.workspace = true

diff --git a/code/crates/network/Cargo.toml b/code/crates/network/Cargo.toml
@@ -5,6 +5,10 @@ edition.workspace = true
 repository.workspace = true
 license.workspace = true
 publish.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [lints]
 workspace = true

diff --git a/code/crates/peer/Cargo.toml b/code/crates/peer/Cargo.toml
@@ -6,6 +6,10 @@ repository.workspace = true
 license.workspace = true
 publish.workspace = true
 rust-version.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [features]
 rand = ["dep:rand"]

diff --git a/code/crates/proto/Cargo.toml b/code/crates/proto/Cargo.toml
@@ -5,6 +5,10 @@ edition.workspace = true
 repository.workspace = true
 license.workspace = true
 publish.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [dependencies]
 prost.workspace = true

diff --git a/code/crates/signing-ed25519/Cargo.toml b/code/crates/signing-ed25519/Cargo.toml
@@ -6,6 +6,10 @@ repository.workspace = true
 license.workspace = true
 rust-version.workspace = true
 publish = false
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [features]
 std = []

diff --git a/code/crates/sync/Cargo.toml b/code/crates/sync/Cargo.toml
@@ -6,6 +6,10 @@ repository.workspace = true
 license.workspace = true
 publish.workspace = true
 rust-version.workspace = true
+readme = "../../../README.md"
+
+[package.metadata.docs.rs]
+all-features = true
 
 [dependencies]
 malachitebft-core-types = { workspace = true }

diff --git a/code/crates/wal/Cargo.toml b/code/crates/wal/Cargo.toml
@@ -6,6 +6,7 @@ repository.workspace = true
 license.workspace = true
 rust-version.workspace = true
 publish.workspace = true
+readme = "../../../README.md"
 
 [package.metadata.docs.rs]
 all-features = true

diff --git a/code/crates/wal/sync.sh b/code/crates/wal/sync.sh