add readme and install script

This commit is contained in:
2 * r + 2 * t
2025-01-26 22:02:15 +11:00
parent 125860de28
commit 6f331f112f
2 changed files with 38 additions and 0 deletions
+30
View File
@@ -0,0 +1,30 @@
# caelestia-scripts
A collection of scripts for my caelestia dotfiles.
## Installation
Run the `install.fish` script in the base of the repo.
`~/.local/bin` must be in your path.
## Usage
```
> caelestia help
Usage: caelestia COMMAND [ ...args ]
COMMAND := help | shell | toggle | workspace-action | scheme | screenshot | record | clipboard | clipboard-delete | emoji-picker | wallpaper | pip
help: show this help message
shell: start the shell or message it
toggle: toggle a special workspace
workspace-action: execute a Hyprland workspace dispatcher in the current group
scheme: change the current colour scheme
screenshot: take a screenshot
record: take a screen recording
clipboard: open clipboard history
clipboard-delete: delete an item from clipboard history
emoji-picker: open the emoji picker
wallpaper: change the wallpaper
pip: move the focused window into picture in picture mode or start the pip daemon
```
Executable
+8
View File
@@ -0,0 +1,8 @@
#!/bin/fish
set -q XDG_CONFIG_HOME && set -l config $XDG_CONFIG_HOME/caelestia || set -l config ~/.config/caelestia
set -l dist $config/scripts
git clone https://github.com/caelestia-dots/scripts.git $dist
mkdir -p ~/.local/bin
ln -s $dist/main.fish ~/.local/bin/caelestia