README: reword some parts

This commit is contained in:
Vaxry 2025-01-02 00:32:08 +01:00
parent 271df559dd
commit e3b6af97dd

View file

@ -1,11 +1,13 @@
# hyprland-protocols # hyprland-protocols
Wayland protocol extensions for Hyprland. Wayland protocol extensions for Hyprland.
This repository exists in an effort to bridge the gap between Hyprland and KDE/Gnome's functionality. This repository exists in an effort to bridge the gap between Hyprland and KDE/Gnome's functionality,
as well as allow apps for some extra neat functionality under Hyprland.
Since `wayland-protocols` is slow to change (on top of Hyprland not being allowed to contribute), we have to maintain Since `wayland-protocols` is slow to change (on top of Hyprland not being allowed to contribute), we have to maintain
a set of protocols Hyprland uses to plumb some things / add a few minor features. Most of the protocols here are small, a set of protocols Hyprland uses to plumb some things / add some useful features.
hyprland-exclusive plumbing protocols anyways.
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_toplevel_export` -> for exporting toplevel buffers (aka. windows) for screensharing
@ -15,7 +17,9 @@ hyprland-exclusive plumbing protocols anyways.
- `hyprland_surface` -> for setting hyprland specific wl_surface properties. - `hyprland_surface` -> for setting hyprland specific wl_surface properties.
# Contributing # Contributing
Adding new protocols is *discouraged*. If the protocol has a good reason to be, and you have an impl ready, feel free to make a PR. 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!
Fixing typos / adding explanations to existing protocols - welcome. Fixing typos / adding explanations to existing protocols - welcome.