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

Add help text for all subcommands #441

Merged
merged 3 commits into from
Jul 6, 2023

Conversation

jessebraham
Copy link
Member

I've kept these fairly minimal for the time being, with the expectation that we will expand on the help text as needed. With that said, would still like to get some feedback on what I have included.

cargo-espflash/src/main.rs Outdated Show resolved Hide resolved
Copy link
Contributor

@bjoernQ bjoernQ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

I think it's helpful for users and I like there are links to further information

Copy link
Member

@SergioGasquez SergioGasquez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Just one small detail that we could add, as some people are confused with this, is that cargo-espflash is able to detect if the app uses esp-idf-sys and if using it, will reuse the partition table and bootloader esp-idf while espflash uses a "hardcoded" bootloader and partition table. But, feel free to disregard it as it's already on the README.

@jessebraham jessebraham merged commit 1c0a14c into esp-rs:main Jul 6, 2023
19 checks passed
@jessebraham jessebraham deleted the feature/help-text branch July 6, 2023 13:12
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

Successfully merging this pull request may close these issues.

3 participants