From 8ff884782426e796100cccbc3c3d8e9a0e061a86 Mon Sep 17 00:00:00 2001
From: Kaley Fischer <46651680+DRAGONTOS@users.noreply.github.com>
Date: Mon, 4 Mar 2024 08:00:27 +0100
Subject: [PATCH] Update README.md
---
README.md | 122 ++++++++++++++++--------------------------------------
1 file changed, 36 insertions(+), 86 deletions(-)
diff --git a/README.md b/README.md
index eb2b7c4..69005ae 100755
--- a/README.md
+++ b/README.md
@@ -1,7 +1,4 @@
-
-
# hy3
-
i3 / sway like layout for [hyprland](https://github.com/hyprwm/hyprland).
@@ -20,27 +17,6 @@ Additional features may be suggested in the repo issues or the [matrix room](htt
### Demo
-### Stability
-hy3 has a tagged release for each hyprland update, and master tracks hyprland's main branch.
-If you are running a release version of hyprland then use the matching tagged hy3 version.
-If you are running an untagged hyprland release then use the `master` branch of hy3.
-
-Commits are tested before pushing and will build against the hyprland release **in the flake.lock file**.
-There may be a mismatch with hyprland's main branch. If hy3 fails to build against hyprland's main branch
-please make an issue or ping me in the [hy3 matrix room](https://matrix.to/#/#hy3-support:outfoxxed.me).
-
-Tagged hy3 versions are always checked against the corresponding hyprland tag.
-
-If you encounter any bugs, please report them in the issue tracker.
-
-When reporting bugs, please include:
-- Commit hash of the version you are running.
-- Steps to reproduce the bug (if you can figure them out)
-- backtrace of the crash (if applicable)
-
-If you are too lazy to use the issue tracker, please at least ping `@outfoxxed:outfoxxed.me`
-in the [matrix room](https://matrix.to/#/#hy3-support:outfoxxed.me) with your bug information.
-
## Installation
> [!IMPORTANT]
@@ -51,6 +27,42 @@ in the [matrix room](https://matrix.to/#/#hy3-support:outfoxxed.me) with your bu
> check out the matching hy3 tag for the hyprland version.
> hy3 tags are formatted as `hl{version}` where `{version}` matches the release version of hyprland.
+### hyprpm
+Hyprland now has a dedicated plugin manager, which should be used when your package manager
+isn't capable of locking hy3 builds to the correct hyprland version.
+
+> [!IMPORTANT]
+> Make sure hyprpm is activated by putting
+>
+> ```conf
+> exec-once = hyprpm reload -n
+> ```
+>
+> in your hyprland.conf. (See [the wiki](https://wiki.hyprland.org/Plugins/Using-Plugins/) for details.)
+
+To install hy3 via hyprpm run
+
+```sh
+hyprpm add https://github.com/outfoxxed/hy3
+```
+
+To update hy3 (and all other plugins), run
+
+```sh
+hyprpm update
+```
+
+(See [the wiki](https://wiki.hyprland.org/Plugins/Using-Plugins/) for details.)
+
+> [!WARNING]
+> When you are running a tagged hyprland version hyprpm (0.34.0+) will build against hy3's
+> corrosponding release. However if you are running an untagged build (aka `-git`) hyprpm
+> will build against hy3's *latest* commit. This means **if you are running an out of date
+> untagged build of hyprland, hyprpm may pick an incompatible revision of hy3**.
+>
+> To fix this problem you will either need to update hyprland or manually build the correct
+> version of hy3.
+
### Nix
#### Hyprland home manager module
Assuming you use hyprland's home manager module, you can easily integrate hy3 by adding it to the plugins array.
@@ -111,41 +123,6 @@ wayland.windowManager.hyprland = {
};
```
-### hyprpm
-Hyprland now has a dedicated plugin manager, which should be used when your package manager
-isn't capable of locking hy3 builds to the correct hyprland version.
-
-> [!IMPORTANT]
-> Make sure hyprpm is activated by putting
->
-> ```conf
-> exec-once = hyprpm reload -n
-> ```
->
-> in your hyprland.conf. (See [the wiki](https://wiki.hyprland.org/Plugins/Using-Plugins/) for details.)
-
-To install hy3 via hyprpm run
-
-```sh
-hyprpm add https://github.com/outfoxxed/hy3
-```
-
-To update hy3 (and all other plugins), run
-
-```sh
-hyprpm update
-```
-
-(See [the wiki](https://wiki.hyprland.org/Plugins/Using-Plugins/) for details.)
-
-> [!WARNING]
-> When you are running a tagged hyprland version hyprpm (0.34.0+) will build against hy3's
-> corrosponding release. However if you are running an untagged build (aka `-git`) hyprpm
-> will build against hy3's *latest* commit. This means **if you are running an out of date
-> untagged build of hyprland, hyprpm may pick an incompatible revision of hy3**.
->
-> To fix this problem you will either need to update hyprland or manually build the correct
-> version of hy3.
### Manual
Install hyprland, including its headers and pkg-config file, then run the following commands:
@@ -160,33 +137,6 @@ The plugin will be located at `build/libhy3.so`, and you can load it normally
Note that the hyprland headers and pkg-config file **MUST be installed correctly, for the target version of hyprland**.
-### Arch (AUR)
-
-> [!NOTE]
-> This method of installation is deprecated and you should use *hyprpm* instead,
-> as it is simpler and less error prone.
-
-> [!CAUTION]
-> Pacman is not very reliable when it comes to building packages in the correct order.
-> If you get a notification saying *hy3 was compiled for a different version of hyprland*
-> then your packages likely updated in the wrong order, or you have hyprland headers in `/usr/local`.
->
-> To fix this, remove `/usr/include/hyprland`, `/usr/local/include/hyprland`, `/usr/share/pkgconfig/hyprland.pc` and `/usr/local/share/pkgconfig/hyprland.pc`,
-> then reinstall hyprland and hy3.
->
-> If you know how to fix this please open an issue or pr, or message `@outfoxxed:outfoxxed.me` in the [matrix room](https://matrix.to/#/#hy3-support:outfoxxed.me).
-
-hy3 stable (for arch's `hyprland` package) is availible on the AUR as [hy3](https://aur.archlinux.org/packages/hy3).
-
-hy3-git (for `hyprland-git` on the AUR, unofficial package) is availible on the AUR as [hy3-git](https://aur.archlinux.org/packages/hy3-git).
-
-Both packages install hy3 as `/usr/lib/libhy3.so`.
-You can enable it in your hyprland configuration by adding the following line anywhere in your `hyprland.conf`
-
-```conf
-plugin = /usr/lib/libhy3.so
-```
-
## Configuration
> [!IMPORTANT]