docs: 📝 Update readme

2025-09-29 05:40:40 +00:00 · 2022-09-20 12:07:33 +00:00 · 2022-09-20 12:07:33 +00:00 · 569580d520
commit 569580d520
parent 7ac3775b3c
1 changed files with 90 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,91 @@
 # EspUp
+Tool for installing and maintaining ESP Rust toolchain.
+> **Warning**
+>
+>  This crate is still in early development (See [Known Issues section](#known-issues)). Use at your own risk and report any issues that you find!
+
+## Installation
+```sh
+cargo install espup --git https://github.com/SergioGasquez/espup
+```
+## Usage
+> **Warning**
+>
+>  Only install subcommand is available at the momment.
+```sh
+USAGE:
+    espup <SUBCOMMAND>
+
+OPTIONS:
+    -h, --help    Print help information
+
+SUBCOMMANDS:
+    help         Print this message or the help of the given subcommand(s)
+    install      Installs esp-rs environment
+    reinstall    Reinstalls esp-rs environment
+    uninstall    Uninstalls esp-rs environment
+    update       Updates esp-rs Rust toolchain
+```
+### Install Subcommand
+```
+Installs esp-rs environment
+
+USAGE:
+    espup install [OPTIONS]
+
+OPTIONS:
+    -b, --build-target <BUILD_TARGET>
+            Comma or space separated list of targets [esp32,esp32s2,esp32s3,esp32c3,all] [default:
+            all]
+
+    -c, --cargo-home <CARGO_HOME>
+            Path to .cargo
+
+    -d, --toolchain-destination <TOOLCHAIN_DESTINATION>
+            Toolchain instalation folder
+
+    -e, --extra-crates <EXTRA_CRATES>
+            Comma or space list of extra crates to install [default: cargo-espflash]
+
+    -f, --export-file <EXPORT_FILE>
+            Destination of the export file generated
+
+    -h, --help
+            Print help information
+
+    -l, --llvm-version <LLVM_VERSION>
+            LLVM version. [13, 14, 15] [default: 14]
+
+    -m, --minified-espidf
+            [Only applies if using -s|--esp-idf-version]. Deletes some esp-idf folders to save space
+
+    -n, --nightly-version <NIGHTLY_VERSION>
+            Nightly Rust toolchain version [default: nightly]
+
+    -q, --quiet
+            Less output per occurrence
+
+    -r, --rustup-home <RUSTUP_HOME>
+            Path to .rustup
+
+    -s, --espidf-version <ESPIDF_VERSION>
+            ESP-IDF version to install. If empty, no esp-idf is installed. Format: -
+            `commit:<hash>`: Uses the commit `<hash>` of the `esp-idf` repository. - `tag:<tag>`:
+            Uses the tag `<tag>` of the `esp-idf` repository. - `branch:<branch>`: Uses the branch
+            `<branch>` of the `esp-idf` repository. - `v<major>.<minor>` or `<major>.<minor>`: Uses
+            the tag `v<major>.<minor>` of the `esp-idf` repository. - `<branch>`: Uses the branch
+            `<branch>` of the `esp-idf` repository
+
+    -t, --toolchain-version <TOOLCHAIN_VERSION>
+            Xtensa Rust toolchain version [default: 1.62.1.0]
+
+    -v, --verbose
+            More output per occurrence
+
+    -x, --clear-dist
+            Removes cached distribution files
+```
+## Known Issues
+ - Esp-idf is only isntalled properpy for `all` targets
+ - Windows throws an error installing esp-idf
+ - Esp-idf source file path is not exported in the file nor displayed in terminal properly