diff --git a/README.md b/README.md index d107822..4e86313 100644 --- a/README.md +++ b/README.md @@ -1,123 +1 @@ -
- -## 💌 ** JaKooLit Hyprland Dot Files ** 💌 - -![GitHub Repo stars](https://img.shields.io/github/stars/JaKooLit/Hyprland-Dots?style=for-the-badge&color=cba6f7) ![GitHub last commit](https://img.shields.io/github/last-commit/JaKooLit/Hyprland-Dots?style=for-the-badge&color=b4befe) ![GitHub repo size](https://img.shields.io/github/repo-size/JaKooLit/Hyprland-Dots?style=for-the-badge&color=cba6f7) - -
-
- -#### Some preview -https://github.com/JaKooLit/Hyprland-Dots/assets/85185940/4bebe592-ca43-4962-9b5c-38f16d63a9fa - -#### 📹 A video walkthroughs -
- YT Videos - -- [Walkthough](https://youtu.be/fO-RBHvVEcc) - -- [V1-Changes](https://youtu.be/upDl1ns05eg) - -- [v2-Changes](https://youtu.be/yaVurRoXc-s) - -#### 📽️ A video coverage by other users. Pls watch and subscribe to their channel -- [`Link`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Videos_and_Reviews) - -
- -## 👁️‍🗨️ My Hyprland install Scripts 👁️‍🗨️ -- You can install Hyprland using Scripts below: - -- [Fedora-Linux](https://github.com/JaKooLit/Fedora-Hyprland) - -- [Debian/Ubuntu-Linux](https://github.com/JaKooLit/Debian-Hyprland) - -- [Arch-Linux](https://github.com/JaKooLit/Arch-Hyprland) - -- [OpenSUSE(Tumbleweed)](https://github.com/JaKooLit/OpenSuse-Hyprland) - -- refer to install scripts what packages needed to install... but atleast, Hyprland packages is needed 😏😏😏 duh!! - -### 👀 Screenshots 👀 -- All screenshots are collected here [Screenshots](https://github.com/JaKooLit/screenshots/tree/main/Hyprland-ScreenShots) - -#### 📦 Whats new? -- To easily track changes, I will be updating the changelogs. [CHANGELOGS](https://github.com/JaKooLit/Hyprland-Dots/wiki/Changelogs) Screenshots will be included if worth it! - -### 💥 Copying / Installation / Update instructions 💥 -- [`MORE INFO HERE`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Install_&_Update) -> [!Note] -> The auto copy script will create backups of intended folders to be copied. However, still a good idea to manually backup just incase script failed to backup! -- ~/.config (btop cava hypr kitty rofi swappy swaylock swaync waybar wlogout) - These are folders to be copied. -- ~/Pictures/wallpapers - Will be backed up -- clone this repo by using git. Change directory, make executable and run the script -```bash -git clone --depth=1 https://github.com/JaKooLit/Hyprland-Dots.git -cd Hyprland-Dots -``` -- to copy/install from upstream (possible bugs) -```bash -chmod +x copy.sh -./copy.sh -``` -- to copy/install from releases (more "stable") -```bash -chmod +x release.sh -./release.sh -``` - -- UPGRADE.sh (Experimental) -> [!IMPORTANT] -> You should atleast v2.2.3 in your hyprland dots (ls ~/.config/hypr) to check version -> You need rsync for it to work - -> [!CAUTION] -> you should have already up and running Hyprland before using this function -```bash -chmod +x upgrade.sh -./upgrade.sh -``` - -#### 🛎️ a small note on wallpapers -- by default, only few wallpapers will be copied (1 each dark and light plus 2 more). You will be offered to download more wallpapers. You can preview/check the additional wallpapers on [`THIS`](https://github.com/JaKooLit/Wallpaper-Bank/tree/main/wallpapers) Link - - -#### ⚠️⚠️⚠️ A MUST! after copying / Installing these dots - -+ By default I have not set a wallpaper. Press SUPER W and set a wallpaper. This is also to initiate pywal for waybar, kitty (tty) and rofi themes. If you use the copy.sh script, you wont need to do this. - -+ Nvidia Owners. Make sure to edit your `~/.config/hypr/UserConfigs/ENVariables.conf` (recommended). Below env's will be activated if automatic copy is used -> WLR_NO_CURSORS,1 , LIBVA_DRIVER_NAME,nvidia , __GLX_VENDOR_LIBRARY_NAME,nvidia - -+ If you have already set your own keybinds, monitors, etc.... Just copy over from backup created before log-out or reboot. (recommended) - -#### 📖 Known issues and possible solutions -- check out this page [FAQ](https://github.com/JaKooLit/Hyprland-Dots/wiki/FAQ) and [UNSOLVED ISSUES](https://github.com/JaKooLit/Hyprland-Dots/wiki/Known_Issues) - - -#### 🙋 QUESTIONS ?!?! ⁉️ -- FAQ! Yes you can use these dotfiles to other distro! Just ensure to install proper packages first! If it makes you feel better, I use same config on my Gentoo and NixOS :) -- QUICK HINT! Click the HINT! Waybar module (note only available in Waybar default and Simple-L [TOP] layout). Can be launched by Keybind SUPER H -- More question? click here [WIKI](https://github.com/JaKooLit/Hyprland-Dots/wiki/) - -#### 🙏 Special request -- If you have improvements on the dotfiles or configuration, feel free to submit a PR for improvement. I always welcome improvements as I am also just learning just like you guys! -- Waybar styles (all those new panel styles require some tweaking) - I kindly request assistance 🙏 - -#### 🤷‍♂️ TO DO! -- [ ] Tweak dots - 🚧 in constant progress -- ~~[ ] Quite possibly switch to starship? Although starship has limited themes compared to oh-my-zsh.~~ no plans for now - -#### 🔮 Discord Server -- kindly join my [Discord](https://discord.gg/V2SJ92vbEN) - -### 💖 Support -- a Star on my Github repos would be nice 🌟 - -- Subscribe to my Youtube Channel [YouTube](https://www.youtube.com/@Ja.KooLit) - -- You can also buy me Coffee Through ko-fi.com or Coffee.com 🤩 - -Buy Me a Coffee at ko-fi.com - -[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/JaKooLit) +I have no idea