diff --git a/Cargo.toml b/Cargo.toml index f4204c5..bddcd3d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,7 @@ name = "web-flash" version = "0.2.1" edition = "2021" +description = "A web server to flash Espressif devices given an ELF file." rust-version = "1.65" authors = [ "Björn Quentin ", diff --git a/README.md b/README.md index 732fd3c..a59ef26 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,42 @@ -# esp-web-flash-server +# web-flash Starts a local server serving a web page to flash a given ELF file. +## Installation ``` -web-flash 0.1.0 - -USAGE: - web-flash.exe [OPTIONS] --chip - -ARGS: - - -OPTIONS: - -b, --bootloader path to bootloader - -c, --chip chip name - -h, --help Print help information - -p, --partition-table path to partition table csv - -V, --version Print version information +cargo install espup +``` +## Usage +``` +Usage: web-flash [OPTIONS] --chip + +Arguments: + + Path to the ELF file + +Options: + -c, --chip + Chip name + + Possible values: + - esp32: ESP32 + - esp32c2: ESP32-C2, ESP8684 + - esp32c3: ESP32-C3, ESP8685 + - esp32c6: ESP32-C6 + - esp32s2: ESP32-S2 + - esp32s3: ESP32-S3 + - esp32h2: ESP32-H2 + - esp8266: ESP8266 + + -b, --bootloader + Path to bootloader + + -p, --partition-table + Path to partition table CSV + + -h, --help + Print help (see a summary with '-h') + + -V, --version + Print version ```