From e4a4934e6f739909fbf346cbc001c72690b5c906 Mon Sep 17 00:00:00 2001 From: ProgAndy Date: Fri, 8 Jan 2021 11:56:50 +0100 Subject: Add README.md --- LICENSE | 2 +- README.md | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/LICENSE b/LICENSE index d2881f3..1d80bd0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2020 ProgAndy +Copyright (c) 202-2021 ProgAndy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/README.md b/README.md new file mode 100644 index 0000000..8ce3924 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# wdomirror + +wdomirror utilizes the wlroots dmabuf export protocol to create a mirror of an outout +with as little overhead as possible. + +## Building + +meson build +ninja -C build + +## Usage + +List the outputs and their IDs. + + ./wdomirror + +Create the mirror + + ./wdomirror $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. + + +## License + +[MIT](LICENSE) -- cgit v1.2.3