Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Relative file paths are resolved from the wrong path #30

Open
LPGhatguy opened this issue Feb 19, 2019 · 0 comments
Open

Relative file paths are resolved from the wrong path #30

LPGhatguy opened this issue Feb 19, 2019 · 0 comments

Comments

@LPGhatguy
Copy link

First off, thanks for the great tool! It's, at the very least, a great holdover until the external_doc feature stabilizes.

I'm working on a project that's a Cargo workspace, so the root of my repository contains my README.md and only a virtual manifest.

If I run cargo-readme in my project root, I get an error hinting that there's no [package] section in my Cargo.toml:

$ cargo readme -o README.md
Error: missing field `package`

I noticed that the -r flag lets me set the project root, which I started using to tell cargo-readme which crate to actually use, so I tried:

$ cargo readme -r snax -o README.md

This writes to snax/README.md instead of ./README.md like I expected! In other words, it behaves differently than:

$ cargo readme -r snax > README.md

Is this intentional?

$ cargo readme --version
cargo-readme v3.1.2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant