diff --git a/.config/hypr/.github/README.md b/.config/hypr/.github/README.md index affa9d51..ad8f7c1c 100644 --- a/.config/hypr/.github/README.md +++ b/.config/hypr/.github/README.md @@ -1,3 +1,86 @@
- +
+ +
+ +
+ +
+ +
+ + + + + +
+ +# :herb: ‎ About + +[Hyprland](https://hyprland.org/) is my default window manager. It has stunning animations (which I always wanted when I started using a WM), excellent Wayland support, dynamic tiling which I prefer over manual or hybrid and an amazing ecosystem of plugins and applications. + +The plugins I'm using are the following: + +- [Hyprsplit](https://github.com/shezdy/hyprsplit) +- [Hyprexpo](https://github.com/hyprwm/hyprland-plugins/tree/main/hyprexpo) +- [Hyprspace](https://github.com/KZDKM/Hyprspace) (_Disabled_) +- [Dynamic Cursors](https://github.com/VirtCode/hypr-dynamic-cursors) (_Disabled_) +- [Hyprtrails](https://github.com/hyprwm/hyprland-plugins/tree/main/hyprtrails) (_Disabled_) + +Alongside this plugins, I use some specific apps from the hypr ecosystem + +- [Hyprlock](https://github.com/hyprwm/hyprlock) +- [Hypridle](https://github.com/hyprwm/hypridle) +- [Hyprpicker](https://github.com/hyprwm/hyprpicker) +- [Hyprshot](https://github.com/Gustash/Hyprshot) (_Script_) +- [Hyprfreeze](https://github.com/Zerodya/hyprfreeze) (_Script_) + +Focusing in the config, hyprland.conf imports every config file, from the binds to the inputs, monitors or the theme. + +If you want to easily configure the workspaces or the monitors, check out [this program](https://github.com/nwg-piotr/nwg-displays). + +Wanna see or add new bindings? Check [this file](../configs/binds.conf). + +Wanna edit the theme? Check [this folder](../theme/). + +Maybe you want to add a new app or service to autostart? Check [this](../scripts/autostart/) + +If you want to add a new script to the config, go to [this folder](../scripts/). + +# :wrench: ‎ Setup + +### :package: Extensions Installation + +You can manage and install extensions with `hyprpm`, a package manager that ships by default with hyprland. Here's a quick reference guide for installing, updating and removing extensions. + +```bash +# Installing an extension +hyprpm add + +# To update all extensions +hyprpm update + +# To remove an specific extension +hyprpm remove +``` + +After you install an extension, make sure to enable it: + +```bash +hyprpm enable +``` + +# :camera: ‎ Gallery + +| **Overview 1** | +| ------------------------------- | +| ![overview-1](./overview-1.png) | + +| **Overview 2** | +| ------------------------------- | +| ![overview-2](./overview-2.png) | + +| **Overview 3** | +| ------------------------------- | +| ![overview-3](./overview-3.png) | diff --git a/.config/hypr/.github/overview-1.png b/.config/hypr/.github/overview-1.png new file mode 100644 index 00000000..0bf21138 Binary files /dev/null and b/.config/hypr/.github/overview-1.png differ diff --git a/.config/hypr/.github/overview-2.png b/.config/hypr/.github/overview-2.png new file mode 100644 index 00000000..5ee1e430 Binary files /dev/null and b/.config/hypr/.github/overview-2.png differ diff --git a/.config/hypr/.github/overview-3.png b/.config/hypr/.github/overview-3.png new file mode 100644 index 00000000..4dec3b12 Binary files /dev/null and b/.config/hypr/.github/overview-3.png differ