diff options
| -rw-r--r-- | README.jp.md | 217 | ||||
| -rw-r--r-- | README.md | 3 |
2 files changed, 220 insertions, 0 deletions
diff --git a/README.jp.md b/README.jp.md new file mode 100644 index 00000000..86edadfa --- /dev/null +++ b/README.jp.md @@ -0,0 +1,217 @@ +[](https://github.com/JaKooLit/Hyprland-Dots/blob/main/README.md) +[](https://github.com/JaKooLit/Hyprland-Dots/blob/main/README.jp.md) + +こんにちは。これは日本語です + +<h3 align="center"> +<img align="center" width="80%" src=https://github.com/user-attachments/assets/bc18bd4d-944b-4d5f-a119-7578fa38f9b4 /> +</h3> + +<p align="center"> + <img src="https://raw.githubusercontent.com/JaKooLit/Hyprland-Dots/main/assets/latte.png" width="400" /> +</p> + +<div align="center"> +<br> + <a href="#installation"><kbd> <br> Installation <br> </kbd></a>   + <a href="https://www.youtube.com/playlist?list=PLDtGd5Fw5_GjXCznR0BzCJJDIQSZJRbxx"><kbd> <br> Youtube <br> </kbd></a>   + <a href="https://github.com/JaKooLit/Hyprland-Dots/wiki"><kbd> <br> Wiki <br> </kbd></a>   + <a href="https://github.com/JaKooLit/Hyprland-Dots/discussions"><kbd> <br> Discussions <br> </kbd></a>   + <a href="https://github.com/JaKooLit/Hyprland-Dots/wiki/Keybinds"><kbd> <br> Keybinds <br> </kbd></a>   + <a href="https://github.com/JaKooLit/Hyprland-Dots/wiki/FAQ"><kbd> <br> FAQ <br> </kbd></a>   + <a href="https://discord.gg/kool-tech-world"><kbd> <br> Discord <br> </kbd></a> +</div><br> + +<div align="center"> + +   <a href="https://discord.gg/kool-tech-world"> <img src="https://img.shields.io/discord/1151869464405606400?style=for-the-badge&logo=discord&color=cba6f7&link=https%3A%2F%2Fdiscord.gg%kool-tech-world"> </a> + +<br/> +</div> + +<h3 align="center"> + <img src="https://github.com/JaKooLit/Telegram-Animated-Emojis/blob/main/Activity/Sparkles.webp" alt="Sparkles" width="38" height="38" /> + KooL's Hyprland Dotfiles Showcase + <img src="https://github.com/JaKooLit/Telegram-Animated-Emojis/blob/main/Activity/Sparkles.webp" alt="Sparkles" width="38" height="38" /> +</h3> + +<div align="center"> + +https://github.com/user-attachments/assets/49bc12b2-abaf-45de-a21c-67aacd9bb872 + +</div> + +#### 📹 A video walkthroughs +- at the bottom + +#### 🎞️ AGS Overview DEMO +- in case you wonder, here is a short demo of AGS overview [Youtube LINK](https://youtu.be/zY5SLNPBJTs) + +</details> + +## 🚩 🏁 Auto Distro-Hyprland install scripts cloning and starting 🇵🇭 +- NOTE: you need package `curl` for this to work + +```bash +sh <(curl -L https://raw.githubusercontent.com/JaKooLit/Hyprland-Dots/main/Distro-Hyprland.sh) +``` +- if you are using say fish or a non-POSIX compliant +```bash +curl -sL https://raw.githubusercontent.com/JaKooLit/Hyprland-Dots/main/Distro-Hyprland.sh | bash +``` + +- you can now use above command to automatically clone the Distro-Hyprland install scripts below +- it will clone the install scripts and start the `install.sh` 😎 + +## Installation +### 👁️🗨️ My Hyprland install Scripts 👁️🗨️ +- Automated Hyprland Scripts for Distro of choice which will pull this dotfiles if opted to install these configurations + +- [Arch-Linux](https://github.com/JaKooLit/Arch-Hyprland) + +- [OpenSUSE(Tumbleweed)](https://github.com/JaKooLit/OpenSuse-Hyprland) + +- [Fedora-Linux](https://github.com/JaKooLit/Fedora-Hyprland) + +- [Debian-Linux (Trixie & SID)](https://github.com/JaKooLit/Debian-Hyprland) + +- [NixOS](https://github.com/JaKooLit/NixOS-Hyprland) + +- [Ubuntu 24.04 LTS](https://github.com/JaKooLit/Ubuntu-Hyprland/tree/24.04) +- [Ubuntu 24.10](https://github.com/JaKooLit/Ubuntu-Hyprland/tree/24.10) +- [Ubuntu 25.04 - (ALPHA STAGE)](https://github.com/JaKooLit/Ubuntu-Hyprland/tree/25.04) + + +### 🪧 Attention 🪧 +- This repo does NOT contain or will NOT install any packages. These are only pre-configured-hyprland configs or dotfiles +- refer to install scripts what packages needed to install... but atleast, Hyprland packages is needed 😏😏😏 duh!! +- This repo will be pulled by the Distro-Hyprland install scripts above if you opt to download pre-configured dots + +### 👀 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](https://github.com/JaKooLit/Hyprland-Dots/wiki/Changelogs) Screenshots will be included if worth mentioning the changes! + +> [!NOTE] +> Kindly note that by defeault, Kools Dots are adjusted / configured for 2k (1440p) display without scaling. + +### 💥 Copying / Installation / Update instructions 💥 +- [`MORE INFO HERE`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Install_&_Update) +> [!Note] +> The auto copy script "copy.sh" will create backups of intended directories to be copied. However, still a good idea to manually backup just incase script failed to backup! +- clone this repo by using git. Change directory, make executable and run the script + +> to download from Master branch +```bash +git clone --depth=1 https://github.com/JaKooLit/Hyprland-Dots.git +cd Hyprland-Dots +``` + +> to download from Development branch (development and testing) +```bash +git clone --depth=1 https://github.com/JaKooLit/Hyprland-Dots.git -b development +cd Hyprland-Dots +``` + +- automatic copy/install of pre-configured dots (recommended for updating) +```bash +chmod +x copy.sh +./copy.sh +``` + +- to copy/install from releases (stable) (note this is 1 version older than in main) +```bash +chmod +x release.sh +./release.sh +``` + +- UPGRADE.sh function +> [!IMPORTANT] +> You need rsync for it to work +> you should have already up and running KooL's Hyprland before using this function +```bash +chmod +x upgrade.sh +./upgrade.sh +``` + +## ❗❗❗ DEBIAN AND UBUNTU HEADS UP! +- I am getting ridiculously amount of messages for updating your KooL Hyprland dotfiles. I have made a BIG note on [`WIKI`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Install_&_Update) + + +#### ⚠️⚠️⚠️ ATTENTION - BACKUPS CREATED by SCRIPT +> [!CAUTION] +> copy.sh, release.sh and even upgrade.sh creates a backup! +> Kindly investigate manually contents on your $HOME/.config +> Delete manually all the backups which you dont need + +#### 🛎️ a small note on wallpapers +- by default, only few wallpapers will be copied (1 each dark and light plus 3 more). You will be offered to download more wallpapers. You can preview/check the additional wallpapers from [`THIS`](https://github.com/JaKooLit/Wallpaper-Bank/tree/main/wallpapers) Link + + +#### ⚠️⚠️⚠️ A MUST! after copying / Installing these dots ++ Press SUPER W and set a wallpaper. This is also to initiate wallust for waybar, kitty (tty) and rofi themes. However, If you use the copy.sh or the release.sh, there will be a preset initial Wallpaper and you dont have to do this + ++ Nvidia Owners. Make sure to edit your `~/.config/hypr/UserConfigs/ENVariables.conf` (highly recommended). +- NVIDIA users / owners, after installation, check [`THIS`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Notes_to_remember#--for-nvidia-gpu-users) + ++ 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:) +- 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 browse through this [WIKI](https://github.com/JaKooLit/Hyprland-Dots/wiki/) +- If you want the old configs, it is collected on my "Archive" repo. See [HERE](https://github.com/JaKooLit/Hyprland-Dots-releases-Archive) + +#### ⌨ Keybinds +- Keybinds [`CLICK`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Keybinds) + +#### 🙏 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.com/invite/kool-tech-world) + + +### 💖 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 give support through coffee's or btc 😊 + +[](https://ko-fi.com/jakoolit) + +or + +[](https://www.buymeacoffee.com/JaKooLit) + +Or you can donate cryto on my btc wallet :) +> 1N3MeV2dsX6gQB42HXU6MF2hAix1mqjo8i + + + + + +## 🫰 Thank you for the stars 🩷 + +<a href="https://star-history.com/#JaKooLit/Hyprland-Dots&Date"> + <picture> + <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=JaKooLit/Hyprland-Dots&type=Date&theme=dark" /> + <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=JaKooLit/Hyprland-Dots&type=Date" /> + <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=JaKooLit/Hyprland-Dots&type=Date" /> + </picture> +</a> + @@ -1,3 +1,6 @@ +[](https://github.com/JaKooLit/Hyprland-Dots/blob/main/README.md) +[](https://github.com/JaKooLit/Hyprland-Dots/blob/main/README.jp.md) + <h3 align="center"> <img align="center" width="80%" src=https://github.com/user-attachments/assets/bc18bd4d-944b-4d5f-a119-7578fa38f9b4 /> </h3> |