feat: create readme

This commit is contained in:
2 * r + 2 * t 2025-06-07 23:17:30 +10:00 committed by GitHub
parent 285221b1ff
commit f4ff07a8b4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

27
README.md Normal file
View file

@ -0,0 +1,27 @@
# caelestia-shell
https://github.com/user-attachments/assets/0840f496-575c-4ca6-83a8-87bb01a85c5f
## Components
- Widgets: [`Quickshell`](https://quickshell.outfoxxed.me/)
- Window manager: [`Hyprland`](https://hyprland.org/)
- Dots: [`caelestia`](https://github.com/caelestia-dots/)
## Installation
### Automated installation (recommended)
Install [`caelestia-scripts`](https://github.com/caelestia-dots/scripts/) and run `caelestia install shell`.
### Manual installation
Clone this repo into `$XDG_CONFIG_HOME/quickshell/caelestia` and run `qs -c caelestia`.
## Credits
Thanks to the Hyprland discord community (especially the homies in #rice-discussion) for all the help and suggestions
for improving these dots!
A special thanks to [@outfoxxed](https://github.com/outfoxxed/) for making Quickshell and the effort put into fixing issues
and implementing various feature requests.