readme: add links, improve formatting

This commit is contained in:
Simon Ser 2019-12-09 12:45:30 +01:00
parent 13076d0c10
commit 03599925b6
No known key found for this signature in database
GPG key ID: 0FDE7BE0E88F5E48

View file

@ -1,36 +1,36 @@
# xdg-desktop-portal-wlr # xdg-desktop-portal-wlr
xdg-desktop-portal backend for wlroots [xdg-desktop-portal] backend for wlroots
## Building ## Building
```sh meson build
meson build ninja -C build
ninja -C build
```
## Installing ## Installing
```sh ninja -C build install
ninja -C build install
```
Make sure `XDG_CURRENT_DESKTOP=sway` is set. Make sure `XDG_CURRENT_DESKTOP=sway` is set.
```sh /usr/lib/xdg-desktop-portal -r &
/usr/lib/xdg-desktop-portal -r & xdg-desktop-portal-wlr
xdg-desktop-portal-wlr
```
## Tooling ## Tooling
Useful tools include `dbus-monitor` to watch requests being made, Useful tools include `dbus-monitor` to watch requests being made,
and `dbus-send` and the similar `busctl call` for manual dbus calls. and `dbus-send` and the similar `busctl call` for manual dbus calls.
You can test the integration with the [portal-test](https://github.com/matthiasclasen/portal-test) flatpak app. You can test the integration with the [portal-test] Flatpak app.
Alternatively you can trigger it with [trigger-screen-shot.py](https://gitlab.gnome.org/snippets/814) and [xdp-screen-cast.py](https://gitlab.gnome.org/snippets/19). Alternatively you can trigger it with [trigger-screen-shot.py] and
[xdp-screen-cast.py].
## License ## License
MIT MIT
[portal-test]: https://github.com/matthiasclasen/portal-test
[xdg-desktop-portal]: https://github.com/flatpak/xdg-desktop-portal
[trigger-screen-shot.py]: https://gitlab.gnome.org/snippets/814
[xdp-screen-cast.py]: https://gitlab.gnome.org/snippets/19