aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index c84bbb2..42f16ae 100644
--- a/README.md
+++ b/README.md
@@ -27,13 +27,14 @@ there is no cloud, account or app-store install.
```sh
git clone https://git.danix.xyz/deck-it ~/Programming/GIT/deck-it
-cp ~/Programming/GIT/deck-it/config.toml ~/.config/deck-it/config.toml # optional
-~/Programming/GIT/deck-it/deck-it
+ln -s ~/Programming/GIT/deck-it/deck-it ~/bin/deck-it
+deck-it
```
The launcher creates the headless output, starts wayvnc and the server, tunnels
them to the tablet, and opens the dashboard and AVNC. `deck-it stop` tears it
-down.
+down. For the dashboard alone, set `enabled = false` under `[display]`: no
+headless output, wayvnc or AVNC.
Over Wi-Fi, pair once and pass the tablet's Wireless debugging address:
@@ -42,13 +43,19 @@ deck-it pair
deck-it wifi 192.168.1.50:41234
```
+Keystone's settings window has a deck-it page: a Start at login switch (it
+adds `deck-it wifi --wait` to hypr-theme's autostart) and every config key,
+launchers included, with a Restart button to apply a save.
+
## Usage
- Tabs: **Dashboard** (draggable/resizable cards), **Windows**, **OBS**. Swipe
the content sideways to change tab.
-- `deck-it install` prints the `exec-once` line for hypr-theme's autostart.
-- Configuration lives in `config.toml`: workspaces, launcher icons, OBS
- websocket, llm-cost-dashboard URL, build VM host, hardware overrides.
+- `deck-it install` prints the `exec-once` line for USB autostart.
+- `config.toml` holds the defaults: display, Wi-Fi address, workspaces,
+ launchers (desktop ids), OBS websocket, llm-cost-dashboard URL, build VM
+ host, hardware overrides. `~/.config/deck-it/config.toml` overrides any of
+ them key by key and needs only what differs; keystone writes it.
- The OBS tab is a stream-deck: scenes, sources, audio sliders, transitions.
Long-press a source to open its properties dialog in OBS.
- The Windows tab has workspaces, icon launchers, and a per-window `⋮` menu to