docs: 📝 Update docs

This commit is contained in:
Sergio Gasquez 2023-06-20 22:06:25 +02:00
parent 47e06dff6c
commit 94396b8e9c
2 changed files with 38 additions and 15 deletions

View File

@ -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 <bjoern.quentin@mobile-j.de>",

View File

@ -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 <CHIP> <ELF>
ARGS:
<ELF>
OPTIONS:
-b, --bootloader <BOOTLOADER> path to bootloader
-c, --chip <CHIP> chip name
-h, --help Print help information
-p, --partition-table <PARTITION_TABLE> path to partition table csv
-V, --version Print version information
cargo install espup
```
## Usage
```
Usage: web-flash [OPTIONS] --chip <CHIP> <ELF>
Arguments:
<ELF>
Path to the ELF file
Options:
-c, --chip <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 <BOOTLOADER>
Path to bootloader
-p, --partition-table <PARTITION_TABLE>
Path to partition table CSV
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
```