mirror of
https://github.com/hyprwm/xdg-desktop-portal-hyprland.git
synced 2024-12-26 03:19:48 +01:00
update readm
This commit is contained in:
parent
b1895a2dfe
commit
c9ab195be6
1 changed files with 4 additions and 49 deletions
53
README.md
53
README.md
|
@ -1,52 +1,7 @@
|
|||
# xdg-desktop-portal-hyprland
|
||||
# v2 rewrite
|
||||
|
||||
[xdg-desktop-portal] backend for hyprland
|
||||
shit is being worked on.
|
||||
|
||||
## What and why?
|
||||
Due to reasons explained in [hyprland-protocols](https://github.com/hyprwm/hyprland-protocols),
|
||||
we have a separate desktop portal impl for Hyprland.
|
||||
going C++
|
||||
|
||||
Although `-wlr` **does** work with Hyprland, `-hyprland` offers more features.
|
||||
|
||||
## Additional dependencies
|
||||
XDPH depends on `qt6` and `qt6-wayland` for the sharing selector. Lack of either will
|
||||
cause screensharing to not work at all.
|
||||
|
||||
## Building
|
||||
|
||||
```sh
|
||||
meson build --prefix=/usr
|
||||
ninja -C build
|
||||
cd hyprland-share-picker && make all && cd ..
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
### From Source
|
||||
|
||||
```sh
|
||||
ninja -C build install
|
||||
sudo cp ./hyprland-share-picker/build/hyprland-share-picker /usr/bin
|
||||
```
|
||||
|
||||
### AUR
|
||||
```sh
|
||||
yay -S xdg-desktop-portal-hyprland-git
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Although should start automatically, consult [the Hyprland wiki](https://wiki.hyprland.org/Useful-Utilities/Hyprland-desktop-portal/)
|
||||
in case of issues.
|
||||
|
||||
## For other wlroots-based compositors
|
||||
If you are a developer and wish to support features that XDPH provides, make sure to support those protocols:
|
||||
- `wlr_foreign_toplevel_management_unstable_v1`
|
||||
- `hyprland_toplevel_export_v1` - XDPH uses Rev2 exclusively (`_with_toplevel_handle`)
|
||||
|
||||
|
||||
## License
|
||||
MIT
|
||||
|
||||
[xdg-desktop-portal]: https://github.com/flatpak/xdg-desktop-portal
|
||||
[screencast compatibility]: https://github.com/emersion/xdg-desktop-portal-wlr/wiki/Screencast-Compatibility
|
||||
idk I will write this some day
|
Loading…
Reference in a new issue