aec4d6b7dafa9bb50896028149fcc61c5d5324e8

Author
outfoxxed <outfoxxed@outfoxxed.me>
Committer
outfoxxed <outfoxxed@outfoxxed.me>
Date

Message

Update readme for new arch install instructions

Diff

 1diff --git a/README.md b/README.md
 2index d53e4e2c8b44d8cb4166e39bf00d43b80109bbae..e50bc79d6286dd317ec864fa33a367b055c4181a 100644
 3--- a/README.md
 4+++ b/README.md
 5@@ -117,7 +117,7 @@ plugin {
 6 ## Installing
 7 
 8 ### Nix
 9-#### Using the home-manager module
10+#### Hyprland home manager module
11 Assuming you use hyprland's home manager module, you can easily integrate hy3 by adding it to the plugins array.
12 
13 ```nix
14@@ -159,7 +159,7 @@ Assuming you use hyprland's home manager module, you can easily integrate hy3 by
15 }
16 ```
17 
18-#### Manually (Nix)
19+#### Manual (Nix)
20 hy3's binary is availible as `${hy3.packages.<system>.hy3}/lib/libhy3.so`, so you can also
21 directly use it in your hyprland config like so:
22 
23@@ -173,19 +173,16 @@ wayland.windowManager.hyprland = {
24 };
25 ```
26 
27-### [Hyprload](https://github.com/Duckonaut/hyprload)
28-Add an entry to your hyprload.toml like so:
29+### Arch (AUR)
30+There is an unofficial [hy3-git](https://aur.archlinux.org/packages/hy3-git) package.
31 
32-```toml
33-plugins = [
34-  # ...
35-  "outfoxxed/hy3",
36-  # ...
37-]
38-```
39+As of writing, the `hyprland-git` AUR package does not properly handle hyprland headers,
40+which are required for hy3 to build. I have been informed that there is a
41+[fixed version](https://gist.githubusercontent.com/eclairevoyant/0007c44a52c715f243452d17362104b3/raw/9b834290ac75bef2f3bb1364d1380832c65ed6bf/PKGBUILD)
42+that places the headers in the correct location.
43 
44 ### Manual
45-Install hyprland, then run the following commands:
46+Install hyprland, including its headers and pkg-config file, then run the following commands:
47 
48 ```sh
49 cmake -DCMAKE_BUILD_TYPE=Debug -B build
50@@ -194,3 +191,5 @@ cmake --build build
51 
52 The plugin will be located at `build/libhy3.so`, and you can load it normally
53 (See [the hyprland wiki](https://wiki.hyprland.org/Plugins/Using-Plugins/#installing--using-plugins) for details.)
54+
55+Note that the hyprland headers and pkg-config file **MUST be installed correctly, for the target version of hyprland**.