memorysafety / zlib-rs

A safer zlib
zlib License
75 stars 6 forks source link

wrong README files included in published crates due to crate metadata error #119

Closed decathorpe closed 4 days ago

decathorpe commented 2 weeks ago

There also appears to be a problem with how README.md is handled in the two crates that are published from this project.

cargo prints this warning when running cargo package:

warning: readme `../README.md` appears to be a path outside of the package,
but there is already a file named `README.md` in the root of the package.
The archived crate will contain the copy in the root of the package.
Update the readme to point to the path relative to the root of the package to remove this warning.

This can indeed be seen that the README shown for both crates on crates.io is the same - the README.md file from the project root:

Since both crates have dedicated README files, this seems like an error. It looks like the file that the relative path set in workspace.readme is preserved when using readme.workspace = true in the workspace members, so this might just not work as you had expected.