From e056c4837b777cb35b0e3db9a2161420bc35df5f Mon Sep 17 00:00:00 2001 From: Jesse Braham Date: Mon, 23 Aug 2021 14:02:18 -0700 Subject: [PATCH] Update repository URLs in both Cargo.toml files, remove build tool info from README --- cargo-espflash/Cargo.toml | 5 ++--- cargo-espflash/README.md | 13 +++---------- espflash/Cargo.toml | 2 +- 3 files changed, 6 insertions(+), 14 deletions(-) diff --git a/cargo-espflash/Cargo.toml b/cargo-espflash/Cargo.toml index b25ad49c..a86eb795 100644 --- a/cargo-espflash/Cargo.toml +++ b/cargo-espflash/Cargo.toml @@ -7,11 +7,10 @@ authors = [ "Robin Appelman ", "Jesse Braham ", ] -repository = "https://github.com/icewind1991/espflash" +repository = "https://github.com/esp-rs/espflash" edition = "2018" [dependencies] -cargo-project = "0.2.4" espflash = { version = "0.1.3", path = "../espflash" } pico-args = "0.4.0" serial = "0.4" @@ -19,4 +18,4 @@ serde = { version = "1", features = ["derive"] } toml = "0.5" cargo_metadata = "0.14.0" guess_host_triple = "0.1.2" -anyhow = "1.0" \ No newline at end of file +anyhow = "1.0" diff --git a/cargo-espflash/README.md b/cargo-espflash/README.md index 218ef650..334f571d 100644 --- a/cargo-espflash/README.md +++ b/cargo-espflash/README.md @@ -2,31 +2,24 @@ _ESP8266_ and _ESP32_ cross-compiler and serial flasher cargo subcommand. -To build the project before flashing, `cargo-espflash` has a few options, specified with the `--tool TOOL` flag. - - - `--tool xbuild`, build using `cargo xbuild`. Requires [cargo xbuild](https://github.com/rust-osdev/cargo-xbuild) installed on your system. This is the default option. - - `--tool cargo`, build using the `build-std` unstable cargo feature. - - `--tool xargo`, build using `xargo`. Requires [xargo](https://github.com/japaric/xargo) installed on your system. +Prior to flashing, the project is built using the `build-std` unstable cargo feature. Please refer to the [cargo documentation](https://doc.rust-lang.org/cargo/reference/unstable.html#build-std) for more information. ## Usage ```bash -$ cargo espflash [--board-info] [--ram] [--release] [--example EXAMPLE] [--chip {esp32,esp8266}] [--tool {{cargo,xargo,xbuild}}] +$ cargo espflash [--board-info] [--ram] [--release] [--example EXAMPLE] [--chip {esp32,esp8266}] ``` When the `--ram` option is specified, the provided ELF image will be loaded into ram and executed without touching the flash. ### Config -You can also specify the serial port or build tool by setting it in the config file located at `~/.config/espflash/espflash.toml` or Linux +You can also specify the serial port by setting it in the config file located at `~/.config/espflash/espflash.toml` or Linux or `%APPDATA%/esp/espflash/espflash.toml` on Windows. ```toml [connection] serial = "/dev/ttyUSB0" - -[build] -tool = "cargo" ``` ### Example diff --git a/espflash/Cargo.toml b/espflash/Cargo.toml index 268de872..736e8351 100644 --- a/espflash/Cargo.toml +++ b/espflash/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Robin Appelman "] edition = "2018" license = "GPL-2.0" description = "ESP8266 and ESP32 serial flasher" -repository = "https://github.com/icewind1991/espflash" +repository = "https://github.com/esp-rs/espflash" [[bin]] name = "espflash"