aboutsummaryrefslogtreecommitdiffstats
path: root/desktop/modules/deckit/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/modules/deckit/README.md')
-rw-r--r--desktop/modules/deckit/README.md28
1 files changed, 14 insertions, 14 deletions
diff --git a/desktop/modules/deckit/README.md b/desktop/modules/deckit/README.md
index 197b382..b3bd39b 100644
--- a/desktop/modules/deckit/README.md
+++ b/desktop/modules/deckit/README.md
@@ -2,12 +2,12 @@
Four settings pages, in their own deck-it sidebar group, for deck-it (the
tablet dashboard, its own repo): whether it starts at login, and its
-`~/.config/deck-it/config.toml`.
+`~/.config/deck-it/config.toml`. Running it is the drawer's: a deck-it tile
+(`DeckItControlModule`) with its state, Start, Stop and Restart.
- Server (`DeckItModule`, `DeckItGeneralPage`): the config path, Start
(start at login, Wi-Fi address), Display, Tabs (the tablet's tabs) and
- Advanced (ports, Hyprland config, fallback icon theme). Its header carries deck-it's state and
- Restart.
+ Advanced (ports, Hyprland config, fallback icon theme). Its header carries deck-it's state.
- Dashboard (`DeckItDashboardModule`, `DeckItDashboardPage`): the
Dashboard parts (the modules without a tab), the action icons, the
tablet screen's idle dimming, and Hardware. `Modules.js` says which of deck-it's `[modules]` are tabs and
@@ -42,17 +42,17 @@ Launchers are desktop ids (`[launch] apps`), added from the installed apps
the way the Autostart page picks one, minus terminal apps. Up and Remove edit
the list; the order is the button order on the tablet.
-deck-it reads its config once at start, so a save applies on Restart
-deck-it, which runs `deck-it stop` and then the login command.
-
-While the Server page is open it polls `deck-it status` (JSON: server, display,
-waiting, tablet, extend) every 2s and shows one line in that page's header,
-beside Restart and Save, as the Wallpaper engine page does: green when the
-server runs with a tablet tunnelled (and the display streams, if enabled),
-yellow while starting or waiting for the tablet, red when stopped. A Restart's
-outcome goes to the window's snackbar: "deck-it restarted" once that state is
-green, or what it saw if it is not back within 30s; a `wifi --wait` with no
-tablet in reach ends there.
+deck-it reads its config once at start, so a save applies on the drawer
+tile's Restart, which runs `deck-it stop` and then the login command; Start
+runs the login command, Stop `deck-it stop`.
+
+While the Server page or the drawer's deck-it page is open it polls `deck-it
+status` (JSON: server, display, waiting, tablet, extend) every 2s and shows
+one line: green when the server runs with a tablet tunnelled (and the display
+streams, if enabled), yellow while starting or waiting for the tablet, red
+when stopped. A Start, Stop or Restart shows "Starting…" and so on, and
+disables the buttons, until the status shows it done (running or waiting, or
+stopped) or 30s pass.
Check: `node desktop/modules/sbbuilder/test_toml.js`; the deck-it side is
tested in its repo.