aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJa.KooLit <jimmielovejay@gmail.com>2024-01-07 08:24:09 +0900
committerGitHub <noreply@github.com>2024-01-07 08:24:09 +0900
commit27557af9ad6f952690e2547c8feec51271d5423c (patch)
tree14dd700bce757341d3063307550504193c2f395b /README.md
parentffbb2da07e040fb75ad89bfaacf03c8d73b7d8c1 (diff)
parent876a392a16bbdea0b16eb28a21b00819d12b9f1a (diff)
Merge branch 'development' into main
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 16 insertions, 5 deletions
diff --git a/README.md b/README.md
index 5cd4b28d..a832888e 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ https://github.com/JaKooLit/Hyprland-Dots/assets/85185940/4bebe592-ca43-4962-9b5
- 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)
+- [`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.
@@ -55,17 +55,29 @@ https://github.com/JaKooLit/Hyprland-Dots/assets/85185940/4bebe592-ca43-4962-9b5
git clone --depth=1 https://github.com/JaKooLit/Hyprland-Dots.git
cd Hyprland-Dots
```
-- to copy/install/update from upstream (possible bugs)
+- to copy/install from upstream (possible bugs)
```bash
chmod +x copy.sh
./copy.sh
```
-- to copy/install/update from releases (more "stable")
+- to copy/install from releases (more "stable")
```bash
chmod +x release.sh
./release.sh
```
+- to update from releases
+> [!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
@@ -93,8 +105,7 @@ chmod +x release.sh
- Waybar styles (all those new panel styles require some tweaking) - I kindly request assistance 🙏
#### 🤷‍♂️ TO DO!
-- [ ] Tweak waybar layouts and Themes - in constant progress
-- [ ] Tweak rofi layouts and Themes in constant progress
+- [ ] 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
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage