search

emersion / xdg-desktop-portal-wlr

xdg-desktop-portal backend for wlroots
MIT License
580 stars 54 forks source link

Explicitely say in README that this project is only about screensharing #236

Open iTrooz opened 1 year ago

iTrooz commented 1 year ago

I had to read https://github.com/emersion/xdg-desktop-portal-wlr/issues/42#issuecomment-667150324 and https://github.com/emersion/xdg-desktop-portal-wlr/blob/94c45603b9dcb68c775da74b4f4b8dc141eac126/wlr.portal#L3 to understand that xdg-desktop-portal-wlr is apparently only supporting screenshare, after trying to debug https://github.com/WerWolv/ImHex/issues/723

I think it could really help to tell people directly in the README that this project only implements the screenshare functionality of xdg-desktop-portal, because the project's name seems to imply that you implement everything (at least from a newcomer's perspective, that's the feeling I got)

Thanks ^^

EDIT : I wanted to make clear that I understand this is my mistake, I am simply proposing this to avoid other people making this mistake as well

columbarius commented 1 year ago

This is actually the first point answered in the FAQ, which is linked on the README ^^

mildred commented 9 months ago

I created #286 to better explain what exactly does xdg-desktop-portal-wlr and how to configure it with recent changes to xdg-desktop-portal following a chat with the xdg-desktop-portal authors over Matrix when trying to debug app issues.

See related issue in xdg-desktop-portal https://github.com/flatpak/xdg-desktop-portal/pull/1172 but their future reworked documentation will probably better explain how it all works.