Cleanup README include in include_str

When running cargo doc, the include_str command works fine, however, cargo publish relocates the package into target/package, so the relative path to the README is different, causing cargo publish to fail. External discussion at: rust-lang/cargo#13309 https://users.rust-lang.org/t/include-str-does-not-work-when-releasing-because-of-changed-pathes/15551/14 The solution suggested in those links is to symlink the top level README inside your package, and then consistently refer to the README in the package. That README will be copied into the right place during cargo publish.
dburgener · Jan 21, 2025 · cb71c60 · cb71c60
1 parent a4fd1d4
commit cb71c60
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/lalrpop/Cargo.toml b/lalrpop/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "lalrpop"
 description = "convenient LR(1) parser generator"
-readme = "../README.md"
+readme = "README.md"
 workspace = ".."
 default-run = "lalrpop"
 

diff --git a/lalrpop/README.md b/lalrpop/README.md
@@ -0,0 +1 @@
+../README.md
diff --git a/lalrpop/src/lib.rs b/lalrpop/src/lib.rs
@@ -1,4 +1,4 @@
-#![doc = include_str!("../../README.md")]
+#![doc = include_str!("../README.md")]
 #![warn(missing_docs)]
 // Need this for rusty_peg
 #![recursion_limit = "256"]