Add dependencies to readme and bump version

This commit is contained in:
Shawn Wallace 2024-05-17 23:49:09 -04:00
parent c1fc38c3d2
commit c95655299e
3 changed files with 7 additions and 2 deletions

2
Cargo.lock generated
View file

@ -713,7 +713,7 @@ dependencies = [
[[package]]
name = "xwayland-satellite"
version = "0.1.0"
version = "0.2.0"
dependencies = [
"bitflags 2.5.0",
"env_logger 0.11.3",

View file

@ -7,7 +7,7 @@ wayland-server = "0.31.1"
[package]
name = "xwayland-satellite"
version = "0.1.0"
version = "0.2.0"
edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

View file

@ -2,6 +2,11 @@
xwayland-satellite grants rootless Xwayland integration to any Wayland compositor implementing xdg_wm_base.
This is particularly useful for compositors that (understandably) do not want to go through implementing support for rootless Xwayland themselves.
## Dependencies
- xcb
- xcb-util-cursor
- clang (building only)
## Usage
Run `xwayland-satellite`. You can specify an X display to use (i.e. `:12`). Be sure to set the same `DISPLAY` environment variable for any X11 clients.
Because xwayland-satellite is a Wayland client (in addition to being a Wayland compositor), it will need to launch after your compositor launches, but obviously before any X11 applications.