aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSamuel Fadel <samuel@nihil.ws>2023-09-28 11:20:21 +0200
committerSamuel Fadel <samuel@nihil.ws>2023-09-28 11:20:21 +0200
commit5c09be045724b6201566a6b5357612ce2e20403b (patch)
tree3e6b6ca7f9b198c1b12fba0f599e2196ba8ae0c8 /README.md
parentf856c9a7b011415360c22d348c1316499105fb57 (diff)
* README.md: cleanup, mention forking
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 15 insertions, 9 deletions
diff --git a/README.md b/README.md
index 8ce3924..aed20a9 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,31 @@
-# wdomirror
+# wlr-mirror
-wdomirror utilizes the wlroots dmabuf export protocol to create a mirror of an outout
-with as little overhead as possible.
+`wlr-mirror` is a fork of
+[https://github.com/ProgAndy/wdomirror](wdomirror) which fixes a
+compilation issue and renames it to make it explicit that it relies on
+wlroots.
+
+It uses the wlroots dmabuf export protocol to create a mirror of an
+output with as little overhead as possible.
## Building
-meson build
-ninja -C build
+ meson build
+ ninja -C build
## Usage
List the outputs and their IDs.
- ./wdomirror
+ wlr-mirror
Create the mirror
- ./wdomirror $ID
+ wlr-mirror $ID
-wdomirror does not preserve the aspect ration, so make sure to set the size of the mirror window correctly.
-For fullscreen, make sure that both source and target outputs have the same aspect ratio.
+wdomirror does not preserve the aspect ratio, so make sure to set the
+size of the mirror window correctly. For fullscreen, make sure that
+both source and target outputs have the same aspect ratio.
## License