From b2bdfc3cdca47d9675bdd45274fa44242e521be9 Mon Sep 17 00:00:00 2001 From: Dante <150515748+xsghetti@users.noreply.github.com> Date: Thu, 14 Mar 2024 14:31:47 -0400 Subject: [PATCH] Update README.md --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 49 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ab860ce6..75e0a76b 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,20 @@ -

HyprCrux Dots

+

HyprCrux Dots

+

Install Script Coming Soon...

-
+ ![GitHub Repo stars](https://img.shields.io/github/stars/xsghetti/dotfiles?style=for-the-badge&logo=github&color=pink) ![GitHub commit activity](https://img.shields.io/github/commit-activity/t/xsghetti/dotfiles?style=for-the-badge&logo=github&color=lightgreen)
+> [!Caution] +> This install script is meant for a minimal Arch Install.
+> If you aren't using the script - these are my personal dots and may not work for you.
+> My configs are messy as I'm not a dev, so use at your own risk. + https://github.com/xsghetti/dotfiles/assets/150515748/e37f75af-a02e-4daf-a652-effecf960f6e ![ss](https://github.com/xsghetti/dotfiles/assets/150515748/0a04d1d5-05ac-4f12-8544-d38917aa3135) @@ -17,20 +23,56 @@ https://github.com/xsghetti/dotfiles/assets/150515748/e37f75af-a02e-4daf-a652-ef ![hyprlock](https://github.com/xsghetti/dotfiles/assets/150515748/2eaffb84-d53e-42cb-ac62-0d00836d66fc) -> [!Caution] -> These are my personal dots and may not work for you. my configs are messy as I'm not a dev, so use at your own risk. -> ## Requires
+> [!Important] +> After Cloning the Repo - Run these commands separately. + + cd ~/dotfiles/Scripts +
+ + ./HyprCrux.sh +
+ + ./install.sh + + +> +> When loading in for the first time, you will get +an initial error from pywal. Feel free to load +your own wallpapers into .config/wallpapers or +use one of mine with the wallpaper selector with +Super + W to select one. Logout & that error +should disappear. + + +> ## Depenencies
> [hyprland](https://hyprland.org)
-> [hyprpm](https://github.com/hyprland-community/awesome-hyprland#plugins)
> [hycov](https://github.com/Ayuei/hycov)
> [hyprtrails](https://github.com/hyprwm/hyprland-plugins/tree/main/hyprtrails)
> [hyprlock](https://github.com/hyprwm/hyprlock)
> [pyprland](https://github.com/hyprland-community/pyprland)
> [pywal](https://github.com/dylanaraps/pywal)
> -> ```Hyprpm requires: meson & cpio```
> ```To get cava working with pywal - symlink template to cava/config``` +> Hycov Keybindings will be commented out by default +to prevent the error message caused by HyprPM.
+HyprTrails is also coded into hyprland.conf but will +not trigger any errors. Feel free to enable them with +the commands below. + + hyprpm update + +
+ + hyprpm add https://github.com/hyprwm/hyprland-plugins +
+ + hyprpm enable hycov +
+ + hyprpm enable hyprtrails + +
D
E
T
A
I
L
S
@@ -41,7 +83,4 @@ https://github.com/xsghetti/dotfiles/assets/150515748/e37f75af-a02e-4daf-a652-ef
OSArch
-> [!IMPORTANT] -> Other QoL packages
- sudo pacman -S hyprland discord kservice5 otf-font-awesome ttf-firacode-nerd ttf-arimo-nerd noto-fonts brightnessctl qt5ct qt6ct waybar sddm polkit-kde-agent pipewire pipewire-pulse pipewire-jack sof-firmware nwg-look