diff --git a/README.md b/README.md index 7189526..6e7d3b6 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,9 @@ Features a modern modular architecture with a status bar, notification system, c - `ttf-roboto` - The default font used for most of the UI - `inter-font` - The default font used for Headers (ex: clock on the LockScreen) - `ttf-material-symbols-variable-git` - Icon font for UI elements +- `gpu-screen-recorder` - Screen recording functionality +- `brightnessctl` - For internal/laptop monitor brightness +- `ddcutil` - For desktop monitor brightness (might introduce some system instability with certain monitors) - `xdg-desktop-portal-gnome` - Desktop integration (or alternative portal) @@ -76,10 +79,10 @@ Features a modern modular architecture with a status bar, notification system, c - `swww` - Wallpaper animations and effects - `matugen` - Material You color scheme generation - `cava` - Audio visualizer component -- `gpu-screen-recorder` - Screen recording functionality -- `brightnessctl` - For internal/laptop monitor brightness -- `ddcutil` - For desktop monitor brightness (might introduce some system instability with certain monitors) -If you want to use the ArchUpdater Widget, make sure you have any polkit agent installed. + +> There are 2 more optional dependencies. +> Any `polkit agent` to be able to use the ArchUpdater widget. +> And also any `xdg-desktop-portal` to be able to use the "Portal" option from the screenRecorder. --- @@ -87,29 +90,52 @@ If you want to use the ArchUpdater Widget, make sure you have any polkit agent i ### Installation -#### For Arch +#### Arch Linux + +
+AUR + +You can install Noctalia from the [AUR](https://aur.archlinux.org/packages/noctalia-shell). This method will install the shell system-wide. + +```bash +paru -S noctalia-shell +``` + +**Note:** When installed from the AUR, you must use the `-c noctalia-shell` flag to run the shell and any IPC commands. For example, to start the shell, run `qs -c noctalia-shell`. See the [Usage](#usage) section for more details. + +
+ +
+Manual Installation + +This method installs the shell to your local user configuration. + ```bash # Install Quickshell -yay -S quickshell-git +paru -S quickshell-git # Download and install Noctalia (latest release) mkdir -p ~/.config/quickshell && curl -sL https://github.com/noctalia-dev/noctalia-shell/releases/latest/download/noctalia-latest.tar.gz | tar -xz --strip-components=1 -C ~/.config/quickshell ``` +
-#### For Nix +#### Nix +
+Nix Installation + +You can run Noctalia directly using the `nix run` command: ```bash nix run github:noctalia-dev/noctalia-shell ``` -
-For flakes - -**Step 1**: Add quickshell and noctalia flakes +Alternatively, you can add it to your NixOS configuration or flake: +**Step 1**: Add Quickshell and Noctalia flakes to your `flake.nix`: ```nix - { + description = "Example Nix flake with Noctalia + Quickshell"; + inputs = { nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; @@ -138,11 +164,8 @@ nix run github:noctalia-dev/noctalia-shell } ``` -and in `configuration.nix` - +**Step 2**: Add the packages to your `configuration.nix`: ```nix - -# your configuration.nix { environment.systemPackages = with pkgs; [ noctalia.packages.${system}.default @@ -151,7 +174,6 @@ and in `configuration.nix` } ``` -
### Usage @@ -178,7 +200,9 @@ and in `configuration.nix`
- Without the binary + Without the binary (Manual or AUR install) + +The following commands apply to a manual installation. If you installed Noctalia via the AUR package, you must add the `-c noctalia-shell` flag to each command (e.g., `qs -c noctalia-shell ipc call launcher toggle`). | Action | Command | | --------------------------- | ----------------------------------------- |