aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..66bc9c4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# wterm - xterm for wayland
+
+
+wterm is an xterm replacement based on st, a simple terminal emulator for X
+originally made by suckless.
+
+
+![logo](contrib/logo/wterm.png "ebin logo")
+
+## Requirements
+
+
+* fontconfig
+* wayland
+* xkbcommon
+* pixman
+* libdrm
+
+## Install
+
+ make clean install
+
+See the man page for additional details.
+
+## Credits
+
+Based on Aurélien APTEL <aurelien dot aptel at gmail dot com> bt source code.
+