From 0759df07275d352b83f4e37df4e4d4bed2a27720 Mon Sep 17 00:00:00 2001 From: ItsDrike Date: Wed, 7 Jun 2023 00:14:36 +0200 Subject: [PATCH] Update installation instructions after move to pkg-config In 6218a99a3a66073e771e1204e1e30ec95ef8b149 the Makefile was updated to use the new `pkg-config` method for including Hyprland soucres, however this commit didn't update the README instructions, which did change a bit. The most notable change is that exporting `HYPRLAND_HEADERS` is no longer necessary, and the updated required Hyprland commit for the plugin. This commit also updates the hyprload instructions. --- README.md | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c273576..b68d6c9 100644 --- a/README.md +++ b/README.md @@ -10,22 +10,35 @@ Since Hyprland plugins don't have ABI guarantees, you should download the Hyprla The guide on compiling and installing Hyprland manually is on the [wiki](http://wiki.hyprland.org/Getting-Started/Installation/#manual-manual-build) -Note, this plugin currently requires hyprland compiled from commit: [`16bc5`](https://github.com/hyprwm/Hyprland/commit/16bc5997bb764a69433def368169a9f41a077dc6) or later. +Note, this plugin currently requires hyprland compiled from commit: [`4afeedbd`](https://github.com/hyprwm/Hyprland/commit/4afeedbd567ca2114f682f14a6de26d4a8188878) or later. ## Using [hyprload](https://github.com/Duckonaut/hyprload) -1. Export the `HYPRLAND_HEADERS` variable to point to the root directory of the Hyprland repo - - `export HYPRLAND_HEADERS="$HOME/repos/Hyprland"` -2. Install - - `make install` + +Add the line `"ItsDrike/hyprland-dwindle-autogroup"` to your `hyprload.toml` config, like this: + +``` +plugins = [ + "ItsDrike/hyprland-dwindle-autogroup", +] +``` + +Then update via `hyprload,update` dispatcher. ## Manual installation -1. Export the `HYPRLAND_HEADERS` variable to point to the root directory of the Hyprland repo - - `export HYPRLAND_HEADERS="$HOME/repos/Hyprland"` -2. Compile - - `make all` -3. Add this line to the bottom of your hyprland config - - `exec-once=hyprctl plugin load ` +1. Clone the Hyprland repository and build the plugin environment + + - `git clone --recursive https://github.com/hyprwm/Hyprland` + - In the Hyprland directory: `make pluginenv` + - Ideally, you should use this instance of Hyprland as your compositor, to do that, run `make install`. This is heavily recommended, as using a different Hyprland instance might cause incompatibilities. + +2. Build the plugn + + - Run `make all` + +3. Add this line to the bottom of your hyprland config + + - `exec-once=hyprctl plugin load ` ## Development