Merge pull request #16 from TheAppgineer/version-0.3.0

Version 0.3.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "roon-tui"
-version = "0.2.0"
+version = "0.3.0"
 authors = ["The Appgineer <[email protected]>"]
 edition = "2021"
 license-file = "LICENSE"
@@ -13,7 +13,7 @@ log = "0.4"
 simplelog = "0.12"
 time = "0.3"
 chrono = { version = "0.4", features = ["clock"], default-features = false }
-ratatui = { version = "0.24.0", features = ["crossterm"], default-features = false }
+ratatui = { version = "0.25.0", features = ["crossterm"], default-features = false }
 crossterm = "0.27.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
@@ -22,7 +22,7 @@ eyre = "0.6"
 any_ascii = "0.3.2"
 rand = "0.8.5"
 clap = { version = "4.4.4", features = ["derive"] }
-roon-api = { git = "https://github.com/TheAppgineer/rust-roon-api.git", tag = "0.1.0", features = ["browse", "transport"] }
+roon-api = { git = "https://github.com/TheAppgineer/rust-roon-api.git", tag = "0.1.1", features = ["browse", "transport"] }
 
 [profile.release]
 strip = true

README.md

@@ -17,6 +17,10 @@ Roon TUI uses an own developed [Rust port](https://github.com/TheAppgineer/rust-
 * Change directory and build the project: `cd roon-tui && cargo build --release`
 * The binary can be found in: `target/release/roon-tui`
 
+#### Updating
+* Get the latest: `git pull`
+* Rebuild: `cargo build --release`
+
 ### Downloading Release Binaries
 Prebuilt binaries can be downloaded from the [latests release](https://github.com/TheAppgineer/roon-tui/releases/latest) page on GitHub. Binaries might have been created by other users for platforms I don't have access to myself.
 
@@ -81,9 +85,19 @@ Roon TUI uses some unicode symbols to improve on looks. If these symbols are not
 ![Roon TUI unicode symbols](images/unicode-symbols.png)
 
 ### Zone Selection and Grouping
-The Roon zone that is controlled by Roon TUI is shown in the lower right corner and can be changed by using `Ctrl-z`.
+The Roon zone that is controlled by Roon TUI is shown in the lower right corner and can be selected via the Zone List (requested using `Ctrl-z`).
+
+The grouping of zones can be viewed and changed by using `Ctr-g`. Ouputs are added or removed from the group by using `Space`, the grouping is activated by using `Enter`. A set grouping can be saved as a preset using `s`, and be restored at a later time. Presets appear in the Zone List and are surrounded by square brackets: `[group-preset]`.
+
+![Save preset](images/save-preset.png)
+
+The Zone list also lists the ouputs that make up a currently active grouping, these outputs are surrounded by angle brackets `<output>`.
+
+A preset or output can be selected to either group or ungroup a zone.
+
+![Zone selection](images/zone-selection.png)
 
-The grouping of zones can be viewed and changed by using `Ctr-g`. Ouputs are added or removed from the group by using `Space`, the grouping is activated by using `Enter`.
+An inactive preset can be deleted by selection it and using `Delete`.
 
 ### Multi-character Jump in Browse View
 After a list of Artists, Albums, etc. is selected, and it is known what to play, a name can be directly typed in the Browse View. The first item that matches the input will be selected. The currently matched characters are displayed in the lower left corner of the view. The Backspace key can be used to revert to previous selections, the Home keys clears the complete input.
@@ -165,20 +179,23 @@ In the Random Album and Random Track mode new entries can be added to the Queue
 |u|Unmute
 |+|Volume up
 |-|Volume down
-### Search Popup
-|||
-|---|---|
-|Enter|Search provided term
-|Esc|Back to Browse view
+|r|Toggle Repeat
+|s|Toggle Shuffle
 ### Zone Select Popup
 |||
 |---|---|
 |Enter|Select Zone
 |Esc|Back to previous view
-
+|Delete|Delete inactive preset
 ### Zone Grouping Popup
 |||
 |---|---|
 |Space|Add or remove output from group
 |Enter|Activate Grouping
+|s|Save as preset
 |Esc|Back to previous view
+### Text Input
+|||
+|---|---|
+|Enter|Confirm input
+|Esc|Cancel input