update readme

dotcypress · Oct 28, 2023 · f8816e8 · f8816e8
1 parent 655776a
commit f8816e8
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "upico"
-version = "0.0.1"
+version = "0.0.0"
 authors = ["Vitaly Domnikov <oss@vitaly.codes>"]
 repository = "https://github.com/dotcypress/upico"
 description = "uPico control app"

diff --git a/readme.md b/readme.md
@@ -24,8 +24,15 @@ Second project name is `atto`, cause 10<sup>−6</sup> * 10<sup>-12</sup> = 10<s
 - [PCB Viewer](https://kicanvas.org/?github=https%3A%2F%2Fgithub.com%2Fdotcypress%2Fupico%2Fblob%2Fmain%2Fpcb%2Fupico.kicad_pcb)
 - [Interactive BOM](https://htmlpreview.github.io/?https://github.com/dotcypress/upico/blob/main/fab/ibom.html)
 
-### Control app building instructions
+### Control app installation
 
+1. Download latest build from [Releases page](https://github.com/dotcypress/upico/releases)
+2. Extract installer: `mkdir dist && tar -xzf upico_%version%.%arch%.tar.gz -C dist`
+3. Install: `cd dist && ./install.sh`
+4. Cleanup: `cd .. && rm -rf dist`
+5. Print help: `upico help`
+
+### Building control app from sources
 1. Install rustup by following the instructions at https://rustup.rs
 2. Clone this repo: `git clone git@github.com:dotcypress/upico.git && cd upico`
 3. Build: `cargo build --release`