From 4d002df1181e0ece60db4745fcf81da300e5c586 Mon Sep 17 00:00:00 2001 From: 2 * r + 2 * t <61896496+soramanew@users.noreply.github.com> Date: Mon, 9 Jun 2025 00:33:16 +1000 Subject: readme: add how to start in usage section --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index e379dcb..58f55e2 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,23 @@ clone this repo into `$XDG_CONFIG_HOME/quickshell/caelestia` and run `qs -c cael ## Usage +The shell can be started in two ways: via systemd or manually running `caelestia shell`. + +### Via systemd + +The install script creates and enables the systemd service `caelestia-shell.service` which should automatically start the +shell on login. + +### Via command + +If not on a system that uses systemd, you can manually start the shell via `caelestia-shell`. +To autostart it on login, you can use an `exec-once` rule in your Hyprland config: +``` +exec-once = caelestia shell +``` + +### Shortcuts/IPC + All keybinds are accessible via Hyprland [global shortcuts](https://wiki.hyprland.org/Configuring/Binds/#dbus-global-shortcuts). For a preconfigured setup, install [`caelestia-hypr`](https://github.com/caelestia-dots/hypr) via `caelestia install hypr` or see [this file](https://github.com/caelestia-dots/hypr/blob/main/hyprland/keybinds.conf#L1-L29) for an example on how to use global -- cgit v1.2.3-freya