@legios/quartermaster 0.1.22 → 0.1.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -77,6 +77,21 @@ the moment you touch it. GNOME does not load a freshly installed extension on
77
77
  Wayland, so when it had to be installed the closing line says so and you have to
78
78
  log out once.
79
79
 
80
+ <img src="docs/img/panel-minimalista.png" alt="The minimalist GNOME panel: one row per bar with its letter, meter, percentage and time to reset" width="300" align="right">
81
+
82
+ **Two looks for the GNOME panel.** The full panel is the default, and it
83
+ explains every account: each bar with its meter and the time to its reset, the
84
+ curve of the one that stops you, where you are heading and how much of today's
85
+ share is left. Once you know how to read it, most of the time you open it for one question — how
86
+ much is left, and when does it come back — and `qm --apariencia=minimalista`
87
+ answers just that: one row per bar with its letter (`s` the session, `w` the
88
+ weekly, `wf` the Fable weekly), its meter, the percentage and the time to the
89
+ reset. Accounts with no number and dormant ones are named in one line at the
90
+ bottom. `qm --apariencia=basica` goes back; `qm --apariencia` says which one is
91
+ set. The choice is saved in `~/.config/quartermaster/config.json` and reaches
92
+ the panel through `qm --json`. The other surfaces don't use it yet. Designed by
93
+ knighthw in [#27](https://github.com/legiosai/quartermaster/issues/27).
94
+
80
95
  The question only appears when there is somewhere to show it: a graphical
81
96
  session, `python3-gi` with `AyatanaAppIndicator3`, and a host for the item — an
82
97
  extension already in place, or a GNOME Shell to install ours into. Without those
@@ -93,7 +108,7 @@ you leave the box ticked — the tray in startup.
93
108
  **Debian and Ubuntu:** the `.deb` from the same release, or the signed apt repo
94
109
  ([two lines](LEEME.md#instalar)).
95
110
 
96
- **Arch:** a `PKGBUILD` in [`paquetes/aur/`](paquetes/aur/PKGBUILD).
111
+ **Arch:** a `PKGBUILD` in [`paquetes/aur/`](paquetes/aur/PKGBUILD) — not on the AUR yet.
97
112
  **Nix:** `nix run github:legiosai/quartermaster`.
98
113
 
99
114
  Needs **Node >= 22.6**: `qm` reads its own TypeScript with no build step, and
@@ -101,6 +116,10 @@ type stripping starts there. The launcher looks for a usable Node on the `PATH`
101
116
  and in nvm, fnm and volta; if it cannot find one it says so and explains how to
102
117
  get one, rather than dying with a syntax error.
103
118
 
119
+ **Shell completion** for bash and zsh — the flags, and your account names for
120
+ `--solo=`, `--ocultar=` and `--cuentas=` — comes with the `.deb` and with
121
+ `make instalar`. The files are in [`paquetes/completions/`](paquetes/completions/).
122
+
104
123
  ## Use
105
124
 
106
125
  ```sh
@@ -157,9 +176,10 @@ the bar that stops you first. They answer different questions — "can I keep
157
176
  going right now?" and "do I make it to the end of the week?" — and either one
158
177
  alone is half an answer.
159
178
 
160
- When that second bar is not the one you would assume — a model-scoped bar, or
161
- one the server sends without a name — the line says which: `main 44%
162
- iguana_necktie` next to a weekly at 13 % is that bar, not a wrong weekly.
179
+ A model-scoped bar says which model: `main 75% Fable`. A bar the server sends
180
+ without a name stays out of the line until it reaches 90 % — where `--aviso`
181
+ starts warning — and then shows with its name, `main 92% iguana_necktie`; below
182
+ that you see the weekly. The full table always lists every bar.
163
183
 
164
184
  ### Language
165
185
 
@@ -418,7 +438,7 @@ secret configured — and says in the log which ones it skipped and why.
418
438
  | **`.deb`** | `sudo apt install ./quartermaster_*.deb` | the same package, standalone | attached to the release |
419
439
  | **Windows installer** | `quartermaster-<v>-setup.exe` | per-user, no UAC: `qm` on `PATH`, tray in the Start menu | attached to the release |
420
440
  | **scoop** | `scoop install quartermaster` | the portable zip, no installer | the tag, automatically |
421
- | **AUR** | `yay -S quartermaster` | `PKGBUILD`, with a real `nodejs>=22.6` | the tag, automatically |
441
+ | **AUR** | not available yet — `makepkg -si` from [`paquetes/aur/`](paquetes/aur/PKGBUILD) | `PKGBUILD`, with a real `nodejs>=22.6` | not yet: off until the AUR account exists |
422
442
  | **Nix** | `nix run github:legiosai/quartermaster` | the flake, with its own Node in the closure | nothing to publish |
423
443
  | **GNOME Extensions** | from the Extensions app | the Shell extension | **by hand** — no upload API |
424
444
  | **waybar** | copy `paquetes/waybar/` | a module for Hyprland, Sway, river | copied by hand |