From 5c09be045724b6201566a6b5357612ce2e20403b Mon Sep 17 00:00:00 2001 From: Samuel Fadel Date: Thu, 28 Sep 2023 11:20:21 +0200 Subject: * README.md: cleanup, mention forking --- README.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) (limited to 'README.md') 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 -- cgit v1.2.3