From db4869ba5da22a5e41d06eb8129fcab78b6a9a67 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Dias?= <65513943+retrozinndev@users.noreply.github.com> Date: Sat, 21 Dec 2024 16:21:47 -0300 Subject: [PATCH] :books: docs(readme): update screenshots and improve instructions --- README.md | 49 ++++++++++++++++++++++++++++--------------------- 1 file changed, 28 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 8b22fc5..734cc1d 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,41 @@ # Retrozinn's Hyprland Dots -My customized Hyprland dotfiles that I keep changing time to time! +My customized Hyprland dotfiles that I keep improving almost everyday 🤩 ! -> [!warning] -> This is a work in progress, it's still not ready to use. -> Currently, I'm making the Eww configuration myself. - -## Recent progress screenshots -Every widget on any of these screenshots are totally functional! Except the notification center. +> [!note] +> Finally, the Eww edition is ready! You can now use it if you want to! :heart:
+> If you're searching for the previous dotfiles with Waybar and Swaync, go +> to the [`waybar-edition`](https://github.com/retrozinndev/Hyprland-Dots/tree/waybar-edition) branch! +## 🌄 Screenshots
+ + + + + + + -![image](repo/eww_shots/desktop.png) -![image](repo/eww_shots/control_center.png) -![image](repo/eww_shots/audio_thing.png) -![image](repo/eww_shots/calendar.png) -![image](repo/eww_shots/logout_menu.png) - + more shots in [`repo/shots`](https://github.com/retrozinndev/Hyprland-Dots/tree/ryo/repo/shots) +
## 🎨 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. +All the colors of the interface are dynamically generated from your wallpaper! This is possible by using [pywal16] (fork of pywal), a cli tool to generate color schemes on the fly. ## đŸ–ŧī¸ Wallpapers -When you're at the [Installation](#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. +When you're at the [Installation](#Installation) process, you can choose whether to install my wallpapers. If you chose to install, you can select any of them by clicking to change wallpaper in the Control Center. Or if you haven't chose to install, you can create the directory `~/wallpapers` in your home directory `~` and put an image you want to use as wallpaper and choose it using the menu inside control center and also by pressing SUPER + W! -### Source +See more bindings inside the `~/.config/hypr/bindings.conf` file or check the [Wiki/Usage] page! + +### ℹī¸ Source All wallpapers inside this repo are not made by me! You can find all sources inside the [`WALLPAPERS.md`](https://github.com/retrozinndev/Hyprland-Dots/blob/ryo/WALLPAPERS.md) file. ## 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`]. +You'll need to have installed all needed packages before installing my dotfiles! Use your package manager to do so. See needed packages in [Wiki/Dependencies]. In order to install this style right away, just run this installation script: @@ -38,10 +44,10 @@ In order to install this style right away, just run this installation script: > 💡 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 + $ git clone https://github.com/retrozinndev/Hyprland-Dots; cd Hyprland-Dots; sh apply.sh ``` -### 🎉 Apps +### 🎉 Tools - Browser: [Zen Browser] - Text Editor: [Neovim], my config is [here](https://github.com/retrozinndev/nvim-conf.lua) - Terminal Emulator: [Kitty] @@ -59,7 +65,7 @@ Thanks to everyone who starred my dotfiles! 💖 [![Stargazers over time](https://starchart.cc/retrozinndev/Hyprland-Dots.svg?background=%2324292e&axis=%23fafbfc&line=%232dba4e)](https://starchart.cc/retrozinndev/Hyprland-Dots) -[pywal]: https://github.com/dylanaraps/pywal +[pywal16]: https://github.com/eylles/pywal16 [zen browser]: https://zen-browser.app [neovim]: https://neovim.io [nushell]: https://nushell.sh @@ -73,7 +79,8 @@ Thanks to everyone who starred my dotfiles! 💖 [issues]: https://github.com/retrozinndev/Hyprland-Dots/issues -[`wiki/dependencies`]: https://github.com/retrozinndev/Hyprland-Dots/wiki/Dependencies +[wiki/dependencies]: https://github.com/retrozinndev/Hyprland-Dots/wiki/Dependencies +[wiki/usage]: https://github.com/retrozinndev/Hyprland-Dots/wiki/Usage [new issue]: https://github.com/retrozinndev/Hyprland-Dots/issues/new