summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavi Ribeiro <104164579+Markus328@users.noreply.github.com>2025-09-03 09:03:01 -0300
committerGitHub <noreply@github.com>2025-09-03 22:03:01 +1000
commitfb9c6d4950ade1007a9a03bf09b31b7dc222a224 (patch)
tree082288028cd3af801a34492e7ab0b67c79b3cf4d /README.md
parentdashboard: add month/year and paging to calendar (#499) (diff)
downloadcaelestia-shell-fb9c6d4950ade1007a9a03bf09b31b7dc222a224.tar.gz
caelestia-shell-fb9c6d4950ade1007a9a03bf09b31b7dc222a224.tar.bz2
caelestia-shell-fb9c6d4950ade1007a9a03bf09b31b7dc222a224.zip
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>
Diffstat (limited to 'README.md')
-rw-r--r--README.md74
1 files changed, 38 insertions, 36 deletions
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.
-
-<details><summary><code>home.nix</code></summary>
-
-```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.
-
-</details>
+### Example configuration
> [!NOTE]
> The example configuration only includes recommended configuration options. For more advanced customisation
> such as modifying the size of individual items or changing constants in the code, there are some other
> options which can be found in the source files in the `config` directory.
-<details><summary>Example configuration</summary>
+<details><summary>Example</summary>
```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
</details>
+### Home Manager Module
+
+For NixOS users, a home manager module is also available.
+
+<details><summary><code>home.nix</code></summary>
+
+```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.
+
+</details>
+
## FAQ
### My screen is flickering, help pls!
@@ -499,7 +501,7 @@ which helped me a lot with learning how to use Quickshell.
Finally another thank you to all the configs I took inspiration from (only one for now):
-- [Axenide/Ax-Shell](https://github.com/Axenide/Ax-Shell)
+- [Axenide/Ax-Shell](https://github.com/Axenide/Ax-Shell)
## Stonks 📈