Add README.md

1 files changed, 27 insertions, 0 deletions

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)