From fb9c6d4950ade1007a9a03bf09b31b7dc222a224 Mon Sep 17 00:00:00 2001
From: Davi Ribeiro <104164579+Markus328@users.noreply.github.com>
Date: Wed, 3 Sep 2025 09:03:01 -0300
Subject: nix/hm: move environment to systemd.environment + refactor (#551)
* nix/hm: environment moved to systemd.environment
* nix/hm: change systemd default target
Follow the home-manager convention for wayland systemd services
* nix/hm: refactor
* readme: refactor configuring section
* readme: fix format
* format
---------
Co-authored-by: 2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>
---
README.md | 74 ++++++++++++++++++++++++++++++++-------------------------------
1 file changed, 38 insertions(+), 36 deletions(-)
(limited to 'README.md')
diff --git a/README.md b/README.md
index 30617ee..0868434 100644
--- a/README.md
+++ b/README.md
@@ -67,7 +67,7 @@ or a devshell. The shell can then be run via `caelestia-shell`.
> The default package does not have the CLI enabled by default, which is required for full funcionality.
> To enable the CLI, use the `with-cli` package.
-For home-manager, you can also use the Caelestia's home manager module (explained in [configuring](https://github.com/caelestia-dots/shell?tab=readme-ov-file#configuring)) that installs and configures the shell and the CLI.
+For home-manager, you can also use the Caelestia's home manager module (explained in [configuring](https://github.com/caelestia-dots/shell?tab=readme-ov-file#home-manager-module)) that installs and configures the shell and the CLI.
### Manual installation
@@ -206,43 +206,14 @@ git pull
All configuration options should be put in `~/.config/caelestia/shell.json`. This file is _not_ created by
default, you must create it manually.
-For NixOS users, a home manager module is also available.
-
-home.nix
-
-```nix
-programs.caelestia = {
- enable = true;
- systemd = {
- enable = false; # if you prefer starting from your compositor
- target = "graphical-session.target";
- };
- settings = {
- bar.status = {
- showBattery = false;
- };
- paths.wallpaperDir = "~/Images";
- };
- environment = [];
- cli = {
- enable = true; # Also add caelestia-cli to path
- settings = {
- theme.enableGtk = false;
- };
- };
-};
-```
-
-The module automatically adds Caelestia shell to the path with **full functionality**. The CLI is not required, however you have the option to enable and configure it.
-
-Example configuration
+Example
```json
{
@@ -420,9 +391,7 @@ The module automatically adds Caelestia shell to the path with **full functional
"audioIncrement": 0.1,
"defaultPlayer": "Spotify",
"gpuType": "",
- "playerAliases": [
- { "from": "com.github.th_ch.youtube_music", "to": "YT Music" }
- ],
+ "playerAliases": [{ "from": "com.github.th_ch.youtube_music", "to": "YT Music" }],
"weatherLocation": "",
"useFahrenheit": false,
"useTwelveHourClock": false,
@@ -444,6 +413,39 @@ The module automatically adds Caelestia shell to the path with **full functional
home.nix
+
+```nix
+programs.caelestia = {
+ enable = true;
+ systemd = {
+ enable = false; # if you prefer starting from your compositor
+ target = "graphical-session.target";
+ environment = [];
+ };
+ settings = {
+ bar.status = {
+ showBattery = false;
+ };
+ paths.wallpaperDir = "~/Images";
+ };
+ cli = {
+ enable = true; # Also add caelestia-cli to path
+ settings = {
+ theme.enableGtk = false;
+ };
+ };
+};
+```
+
+The module automatically adds Caelestia shell to the path with **full functionality**. The CLI is not required, however you have the option to enable and configure it.
+
+