feat: create readme
This commit is contained in:
parent
285221b1ff
commit
f4ff07a8b4
1 changed files with 27 additions and 0 deletions
27
README.md
Normal file
27
README.md
Normal 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.
|
||||
Loading…
Add table
Reference in a new issue