docs: link main README to each crate for #194

SichangHe · Aug 18, 2024 · f536ccc · f536ccc
1 parent af42011
commit f536ccc
Show file tree

Hide file tree

Showing 16 changed files with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -77,7 +77,7 @@ please see [#164][issue164].
     to parse IRRs and to test run verification.
     The REPL scripts are in
     the module at `./route_verification/src/evcxr_examples.rs`.
-    `rib_stats` is a main script to generate statistics for
+    `route_verification_rib_stats` is a main script to generate statistics for
     all BGP table dumps at a directory, on the AS, AS-pair, and route levels.
 
     We chose Rust for the IR, parser,

diff --git a/route_verification/Cargo.toml b/route_verification/Cargo.toml
@@ -61,6 +61,7 @@ route_verification = { package = "route_verification", path = ".", version = "0.
 [workspace.package]
 description = "Parse RPSL in the IRR to verify observed BGP routes"
 license = "MIT"
+readme = "../README.md"
 repository = "https://github.com/SichangHe/internet_route_verification"
 
 [package]
@@ -70,6 +71,7 @@ edition = "2021"
 
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 [dependencies]

diff --git a/route_verification/as_path_regex/Cargo.toml b/route_verification/as_path_regex/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

diff --git a/route_verification/as_rel/Cargo.toml b/route_verification/as_rel/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 [dependencies]

diff --git a/route_verification/bgp/Cargo.toml b/route_verification/bgp/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 [dependencies]

diff --git a/route_verification/bgpmap/Cargo.toml b/route_verification/bgpmap/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 [dependencies]

diff --git a/route_verification/common_regex/Cargo.toml b/route_verification/common_regex/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

diff --git a/route_verification/graph/Cargo.toml b/route_verification/graph/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 edition = "2021"
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

diff --git a/route_verification/io/Cargo.toml b/route_verification/io/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 [dependencies]

diff --git a/route_verification/ir/Cargo.toml b/route_verification/ir/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 [dependencies]

diff --git a/route_verification/irr/Cargo.toml b/route_verification/irr/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 [dependencies]

diff --git a/route_verification/lex/Cargo.toml b/route_verification/lex/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 [dependencies]

diff --git a/route_verification/parse/Cargo.toml b/route_verification/parse/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 [dependencies]

diff --git a/route_verification/rib_stats/Cargo.toml b/route_verification/rib_stats/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.3"
 edition = "2021"
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

diff --git a/route_verification/shared_struct/Cargo.toml b/route_verification/shared_struct/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 
 description.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
 [dependencies]

diff --git a/route_verification/stat_route_objects/Cargo.toml b/route_verification/stat_route_objects/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 description.workspace = true
 license.workspace = true
 repository.workspace = true
+publish = false
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html