Add installation instructions

Author: nullstalgia

.github/workflows/release.yml

@@ -48,7 +48,7 @@ jobs:
         uses: taiki-e/upload-rust-binary-action@v1
         with:
           bin: yap
-          features: yap-full
+          features: yap-full,self-replace
           target: ${{ matrix.target }}
           include: LICENSE,README.md,example_configs
           tar: unix
@@ -60,7 +60,7 @@ jobs:
         uses: taiki-e/upload-rust-binary-action@v1
         with:
           bin: yap
-          features: yap-lite
+          features: yap-lite,self-replace
           target: ${{ matrix.target }}
           include: LICENSE,README.md,example_configs
           tar: unix

Cargo.toml

@@ -31,7 +31,7 @@ self-replace = ["dep:self-replace", "portable", "yap-lite"]
 # Full should have _all_ features enabled and available
 yap-full = ["yap-lite", "espflash", "defmt-watch"]
 # Lite trims things not everyone might want (i.e. espflash and defmt support)
-yap-lite = ["self-replace", "logging", "macros"]
+yap-lite = ["logging", "macros"]
 
 [dependencies]
 ansi-to-tui = { git = "https://github.com/nullstalgia/ansi-to-tui", branch = "lossy_and_line_endings" }

README.md

@@ -30,3 +30,55 @@ https://github.com/user-attachments/assets/647d0172-3f79-4d47-974d-48f344adc645
 
 ### espflash Flashing Example:
 https://github.com/user-attachments/assets/d14e6aa2-51d1-489f-b8ba-ca88f74ad3d2
+
+# Pre-compiled Downloads
+
+Pre-compiled portable binaries can be found in [Releases](https://github.com/nullstalgia/yap/releases).
+
+`yap-full` builds have all optional features enabled!
+
+`yap-lite` builds exclude less universally-applicable features (currently excluded: `espflash`, `defmt`, `defmt_watch`).
+
+# Installation
+
+Crates.io releases are not yet available (due to some dependencies not being available/yet released to crates.io).
+
+Local installation can be accomplished by cloning the repository and running
+
+```cargo install --path . --no-default-features --features yap-full```
+
+(or `yap-lite` or any other combination of features).
+
+Enabling `self-replace` or `portable` on installed builds is not recommended or supported.
+
+# Usage
+
+Open port selection:
+
+```
+yap
+```
+
+Try to connect to port at `COM1`:
+
+```
+yap COM1
+```
+
+Try to connect to port at `COM1` with 9600 baudrate:
+
+```
+yap COM1 9600
+```
+
+Try to connect to found USB device with VID 303A and PID 1001:
+
+```
+yap 303A:1001
+```
+
+Try to connect to found USB device with VID 303A and PID 1001 and Serial Number 123456 with 9600 baudrate:
+
+```
+yap 303A:1001:123456 9600
+```