README: Add build instructions (#19)

Change headings to h2
This commit is contained in:
Chris Hixon 2025-06-04 08:18:34 -06:00 committed by GitHub
parent 3a5c2bda1c
commit 613878cb6f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -9,7 +9,7 @@ a set of protocols Hyprland uses to plumb some things / add some useful features
Some of the protocols here also do not belong in w-p, as they are specific to Hyprland.
# Finished protocols
## Finished protocols
- `hyprland_toplevel_export` -> for exporting toplevel buffers (aka. windows) for screensharing
- `hyprland_global_keybindings` -> for managing global keybinds via D-Bus.
- `hyprland_focus_grab` -> for grabbing input focus, primarily for complex context menus.
@ -18,7 +18,15 @@ Some of the protocols here also do not belong in w-p, as they are specific to Hy
- `hyprland_lock_notify` -> for notifying a client about the screen being locked and unlocked.
- `hyprland_toplevel_mapping` -> for mapping toplevels to hyprland IDs.
# Contributing
## Building
```sh
git clone https://github.com/hyprwm/hyprland-protocols
cd hyprland-protocols
meson setup build
sudo meson install -C build
```
## Contributing
Adding new protocols is *discouraged*, as most things you think of can already be done one way or another.
However, if the protocol has a good reason to be, and you have an impl ready, feel free to make a PR.
We're always up for a discussion to improve things!