diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9eff4ac --- /dev/null +++ b/README.md @@ -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 +``` |