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.

Sign up for GitHub

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 link to espflash dependencies #124

Merged
merged 1 commit into from
Oct 17, 2023
Merged

Add link to espflash dependencies #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/tooling/espflash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The [`espflash`][espflash] repository contains two crates, `cargo-espflash` and

Provides a subcommand for `cargo` that handles cross-compilation and flashing.

To install, run:
To install `cargo-espflash`, ensure that you have the [necessary dependencies][cargo-espflash-dependencies] installed, and then execute the following command:

```shell
cargo install cargo-espflash
Expand All @@ -28,12 +28,13 @@ cargo espflash flash --example=blinky --monitor
For more information, please see the [`cargo-espflash`][cargo-espflash] README.

[cargo-espflash]: https://github.com/esp-rs/espflash/blob/master/cargo-espflash/README.md
[cargo-espflash-dependencies]: https://github.com/esp-rs/espflash/blob/main/cargo-espflash/README.md#installation

## `espflash`

Provides a standalone command-line application that flashes an ELF file to a device.

To install, run:
To install `espflash`, ensure that you have the [necessary dependencies][espflash-dependencies] installed, and then execute the following command:

```shell
cargo install espflash
Expand All @@ -56,3 +57,4 @@ With this configuration, you can flash and monitor your application using `cargo

[esp-idf]: https://github.com/espressif/esp-idf
[espflash-readme]: https://github.com/esp-rs/espflash/blob/master/espflash/README.md
[espflash-dependencies]:https://github.com/esp-rs/espflash/blob/main/espflash/README.md#installation