about summary refs log tree commit diff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 000000000000..49ba04b33a7b
--- /dev/null
+++ b/README.org
@@ -0,0 +1,15 @@
+#+TITLE: Emacs X Window Manager
+
+EXWM (Emacs X Window Manager) is a full-featured tiling X window manager for
+Emacs built on top of [[https://github.com/ch11ng/xelb][XELB]].
+It features:
++ Fully keyboard-driven operation
++ Hybrid layout modes (tiling & stacking)
++ Workspace support
++ ICCCM/EWMH compliance
++ Basic RandR support (optional)
+
+Please check the [[https://github.com/ch11ng/exwm/wiki][User Guide]] for more details.
+
+*Note*: If you install EXWM from source, you need to manually install XELB
+(either from source or GNU ELPA).