aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJa.KooLit <ejhay.games@gmail.com>2023-12-24 14:14:02 +0900
committerJa.KooLit <ejhay.games@gmail.com>2023-12-24 14:14:02 +0900
commitd04d87d5f47f9ba130bbffd7cde4d3a6ac7b840d (patch)
tree6e864293f6c638e1d3b26b555227f339bd2c8016 /README.md
parentffd9c409864d7934c24abde08b5f9692f96d9a54 (diff)
updated readme and initial-boot behaviour
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 17 insertions, 17 deletions
diff --git a/README.md b/README.md
index 1f4e4aed..0f68abb1 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,13 @@
<div align="center">
-# 💌 ** JaKooLit Hyprland Dot Files ** 💌
+## 💌 ** 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)
<br/>
</div>
-### Some preview
+#### Some preview
https://github.com/JaKooLit/Hyprland-Dots/assets/85185940/4bebe592-ca43-4962-9b5c-38f16d63a9fa
## 👁️‍🗨️ My Hyprland install Scripts 👁️‍🗨️
@@ -23,31 +23,31 @@ https://github.com/JaKooLit/Hyprland-Dots/assets/85185940/4bebe592-ca43-4962-9b5
- refer to install scripts what packages needed to install... but atleast, Hyprland packages is needed 😏😏😏 duh!!
-## 👀 Screenshots 👀
+### 👀 Screenshots 👀
- All screenshots are collected here [Screenshots](https://github.com/JaKooLit/screenshots/tree/main/Hyprland-ScreenShots)
-### 📦 Whats new?
+#### 📦 Whats new?
- To easily track changes, I will be updating the changelogs. [CHANGELOGS](https://github.com/JaKooLit/Hyprland-Dots/wiki/7.-CHANGELOGS) Screenshots will be included if worth it!
-### 📹 A video walkthroughs
+#### 📹 A video walkthroughs
- [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
+#### 📽️ A video coverage by other users. Pls watch and subscribe to their channel
- [`Link`](https://github.com/JaKooLit/Hyprland-Dots/wiki/8.-Videos-and-Reviews)
-## 💥 Copying / Installation / Update instructions 💥
+### 💥 Copying / Installation / Update instructions 💥
- [`MORE INFO HERE`](https://github.com/JaKooLit/Hyprland-Dots/wiki/2.-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!
+> [!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 dunst hypr kitty rofi swappy swaylock 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 https://github.com/JaKooLit/Hyprland-Dots.git
+git clone --depth=1 https://github.com/JaKooLit/Hyprland-Dots.git
cd Hyprland-Dots
```
- to copy/install/update from upstream (possible bugs)
@@ -61,11 +61,11 @@ chmod +x release.sh
./release.sh
```
-### 🛎️ a small note on wallpapers
+#### 🛎️ 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
+#### ⚠️⚠️⚠️ 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.
@@ -73,28 +73,28 @@ chmod +x release.sh
+ 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
+#### 📖 Known issues and possible solutions
- check out this page [FAQ](https://github.com/JaKooLit/Hyprland-Dots/wiki/4.-FAQ) and [UNSOLVED ISSUES](https://github.com/JaKooLit/Hyprland-Dots/wiki/6.-Known-Issues)
-### 🙋 QUESTIONS ?!?! ⁉️
+#### 🙋 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
+#### 🙏 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!
+#### 🤷‍♂️ TO DO!
- [ ] Tweak waybar layouts and Themes - in constant progress
- [ ] Tweak rofi layouts and Themes in constant progress
- ~~[ ] Quite possibly switch to starship? Although starship has limited themes compared to oh-my-zsh.~~ no plans for now
-### 🔮 Discord Server
+#### 🔮 Discord Server
- kindly join my [Discord](https://discord.gg/V2SJ92vbEN)
-## 💖 Support
+### 💖 Support
- a Star on my Github repos would be nice 🌟
- Subscribe to my Youtube Channel [YouTube](https://www.youtube.com/@Ja.KooLit)
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage