nosignal/nosignal-shell
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

readme: add local changes example

Browse source 
Also remove releases installation section
This commit is contained in:
2 * r + 2 * t 2025-08-29 00:43:57 +10:00
parent 85784700a3
commit 45bf808686
1 changed files with 10 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -63,30 +63,6 @@ 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. > 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. > To enable the CLI, use the `with-cli` package.
### Release
#### Self-contained installer
Simply download the self-contained installer from the [latest release](https://github.com/caelestia-dots/shell/releases/latest)
and run it.
```sh
curl -sL https://github.com/caelestia-dots/shell/releases/latest/download/caelestia-shell-latest.sh -o install.sh && chmod u+x install.sh && sudo ./install.sh --exclude-subdir --prefix=/
```
#### Tarball
Download the tarball from the [latest release](https://github.com/caelestia-dots/shell/releases/latest),
then extract it to your root directory.
```sh
curl -sL https://github.com/caelestia-dots/shell/releases/latest/download/caelestia-shell-latest.tar.gz | sudo tar -xz --strip-components=1 -C /
```
> [!TIP]
> For both the installer and tarball, you can move/copy the `/etc/xdg/quickshell/caelestia` directory
> after installation to `$XDG_CONFIG_HOME/quickshell/caelestia` to be able to make your own local changes.
### Manual installation ### Manual installation
Dependencies: Dependencies:
@ -136,6 +112,16 @@ sudo cmake --install build
> `INSTALL_QSCONFDIR` for the libraries (the beat detector), QML plugin and Quickshell config directories > `INSTALL_QSCONFDIR` for the libraries (the beat detector), QML plugin and Quickshell config directories
> respectively. If changing the library directory, remember to set the `CAELESTIA_LIB_DIR` environment > respectively. If changing the library directory, remember to set the `CAELESTIA_LIB_DIR` environment
> variable to the custom directory when launching the shell. > variable to the custom directory when launching the shell.
>
> e.g. installing to `~/.config/quickshell/caelestia` for easy local changes:
>
> ```sh
> mkdir -p ~/.config/quickshell/caelestia
> cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/ -DINSTALL_QSCONFDIR=~/.config/quickshell/caelestia
> cmake --build build
> sudo cmake --install build
> sudo chown -R $USER ~/.config/quickshell/caelestia
> ```
## Usage ## Usage