about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..58585cdce9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Emacs X Window Manager
+
+EXWM (Emacs X Window Manager) is a full-featured tiling X window manager
+for Emacs built on top of [XELB](https://github.com/emacs-exwm/xelb).
+
+It features:
++ Fully keyboard-driven operations
++ Hybrid layout modes (tiling & stacking)
++ Dynamic workspace support
++ ICCCM/EWMH compliance
+
+Optional features:
++ RandR (multi-monitor) support
++ System tray
++ Input method
++ Background setting support
++ XSETTINGS server
+
+Please check out the
+[screenshots](https://github.com/emacs-exwm/exwm/wiki/Screenshots)
+to get an overview of what EXWM is capable of, and the
+[user guide](https://github.com/emacs-exwm/exwm/wiki)
+for installation instructions and a detailed explanation of its usage.