We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
First off, thanks for the great tool! It's, at the very least, a great holdover until the external_doc feature stabilizes.
external_doc
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.
README.md
If I run cargo-readme in my project root, I get an error hinting that there's no [package] section in my Cargo.toml:
[package]
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:
-r
$ 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:
snax/README.md
./README.md
$ cargo readme -r snax > README.md
Is this intentional?
$ cargo readme --version cargo-readme v3.1.2
The text was updated successfully, but these errors were encountered:
No branches or pull requests
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 myCargo.toml
: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:This writes to
snax/README.md
instead of./README.md
like I expected! In other words, it behaves differently than:Is this intentional?
The text was updated successfully, but these errors were encountered: