Error: README.md in lib.rs while vendoring

[mplsgrant]

taffy version

taffy = "0.1.0"

Platform

Rust, debian linux

What you did

I tried to vendor my sources.

1. git clone https://github.com/mplsgrant/taproot-bevy-taffy-error.git
2. cd taproot-bevy-taffy-error/
3. mkdir vendor
4. cargo vendor vendor
5. vim .cargo/config.toml

Uncomment at the bottom of .cargo/config.toml:

[source.crates-io]
replace-with = "vendored-sources"

[source.vendored-sources]
directory = "vendor"

6. cargo build

What went wrong

I got the following error:

error: couldn't read /home/user/taproot-bevy-taffy-error/vendor/taffy/src/../README.md: No such file or directory (os error 2)
--> /home/user/taproot-bevy-taffy-error/vendor/taffy/src/lib.rs:1:10
|
1 | #![doc = include_str!("../README.md")]
|          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= note: this error originates in the macro `include_str` (in Nightly builds, run with -Z macro-backtrace for more info)

error: could not compile `taffy` due to previous error

[TimJentzsch]

I think this is a duplicate of #217 and fixed by #219. We probably just need to publish a new release with the changes.

[nicoburns]

Perhaps it might be worth doing a 0.1.1 release for this? It seems silly to make people upgrade to breaking changes for this, and it's a one-line change to the Cargo.toml, so the fix ought to apply cleanly to the released 0.1 version.

[mplsgrant]

I like the 0.1.1 release plan.

For what it's worth, I fed #219 to cargo semver-checks check-release (which checks for subtle semver violations), and it passed all its checks which is a good thing.