about summary refs log tree commit diff
path: root/README.org
diff options
context:
space:
mode:
authorChris Feng <chris.w.feng@gmail.com>2015-09-21T05·31+0800
committerChris Feng <chris.w.feng@gmail.com>2015-09-21T05·31+0800
commit623db8b378949b0dd863bd8ee069417973b69bad (patch)
tree3e5820ae9c1559b85bc6dec7b6546e13ec8cd9aa /README.org
parent9f30672b15abd84e5755ed36f505830e80739b13 (diff)
Minor fixes for packaging
* .gitignore: Add ELPA files.
* exwm-workspace.el: Autoload exwm-workspace-switch.
* README.org: Renamed from README.md; add an installation note.
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).