Initial commitHEADv0.1master

1 files changed, 39 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2521691
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# kwin-type
+#### by Jason A. Donenfeld ([Jason@zx2c4.com](mailto:Jason@zx2c4.com))
+
+Autotype text from stdin, on KDE's KWin Wayland compositor.
+
+## Building
+
+```
+$ make
+```
+
+Building requires wayland-client ≥ 1.23 and xkbcommon ≥ 1.0. Running requires kwin ≥ 6.8 and a libc with C.UTF-8 support.
+
+## Installing
+
+```
+# make install
+```
+
+This command takes into account several environment variables:
+
+  * `PREFIX`               default: `/usr`
+  * `DESTDIR`              default:
+  * `BINDIR`               default: `$(PREFIX)/bin`
+  * `MANDIR`               default: `$(PREFIX)/share/man`
+  * `PKG_CONFIG`           default: `pkg-config`
+
+## Usage
+
+```bash
+$ printf 'Hello, world!\n' | kwin-type
+$ kwin-type < text.txt
+```
+
+See the [man page](kwin-type.1) for more information.
+
+## License
+
+This project is released under the [GPLv2](COPYING).