diff --git a/README.md b/README.md index 6230d14..4d882b5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# Retrozinndev's Hyprland Dots -My personal Hyprland configuration that I use everyday! Some of the colors available in stylesheet files can be found in the [Catppuccin Mocha Palette](https://catppuccin.com/palette#flavor-mocha), go check it out, it's awesome! +# Retrozinn's Hyprland Dots +My customized Hyprland configuration that I use everyday!
@@ -13,24 +13,45 @@ My personal Hyprland configuration that I use everyday! Some of the colors avail https://github.com/user-attachments/assets/f67fbeea-637b-44f3-b935-cfdb82680007
+## 🎨 Colors +All the colors are dynamically based on the current wallpaper! This is possible by using [pywal], a cli tool to generate colorschemes by using an image as a base. + +## đŸ–ŧī¸ Wallpapers +When you're at the [Installation] process, you can choose to copy my dotfiles' wallpapers folder. If you chose to copy, you can change the current wallpaper by pressing SUPER + W, or clicking to change wallpaper in the Control Center. + ## Installation -You'll need to have installed all needed packages before installing my dotfiles! Use your package manager to do so. See needed packages on [`Wiki#Dependencies`](https://github.com/retrozinndev/Hyprland-Dots/wiki/Dependencies). +You'll need to have installed all needed packages before installing my dotfiles! Use your package manager to do so. See needed packages on [`Wiki/Dependencies`]. In order to install this style right away, just run this installation script: > â„šī¸ Notice: the installation script will make a backup folder containing all previous files in `~/hyprland-dots-bkp`. -> ❕ Tip: The `$` character means that you can run this command without a root/super user. +> ❕ Tip: Note the `$` character means that it's recommended to run this command without root privileges. ```nushell $ git clone "https://github.com/retrozinndev/Hyprland-Dots.git"; cd Hyprland-Dots; bash apply.sh ``` -### How to Use -See usage [on the wiki](https://github.com/retrozinndev/Hyprland-Dots/wiki/Usage). +### ❔ How to Use +See usage and other relevant info on the [Wiki]. ## ❗ Issues -Got any issue? Please report it at the [Issues Tab](https://github.com/retrozinndev/Hyprland-Dots/issues/new), I'll be happy for helping you out! +Got any issue? Please create a [new Issue], I'll be happy for helping you out! ## 📜 License -This repo is licensed under the [GNU General Public License 3.0](https://www.gnu.org/licenses/gpl-3.0.pt.html#license-text) +This repo is licensed under the [GNU General Public License 3.0]. + + + +[pywal]: https://github.com/dylanaraps/pywal +[gnu general public license 3.0]: https://www.gnu.org/licenses/gpl-3.0.pt.html#license-text + + +[wiki]: https://github.com/retrozinndev/Hyprland-Dots/wiki +[issues]: https://github.com/retrozinndev/Hyprland-Dots/issues + + +[`wiki/dependencies`]: https://github.com/retrozinndev/Hyprland-Dots/wiki/Dependencies + + +[new issue]: https://github.com/retrozinndev/Hyprland-Dots/issues/new