about summary refs log tree commit diff
path: root/third_party/exwm/README.md
diff options
context:
space:
mode:
authorVincent Ambo <mail@tazj.in>2021-09-15T19·35+0300
committerVincent Ambo <mail@tazj.in>2021-09-15T19·35+0300
commitcefff2ca25b327c3b7d5925f75d19419796acb2d (patch)
tree3fc362939bfc172acf9fe1d38b7d5c95d2136edd /third_party/exwm/README.md
parent7894d7e178ac542f2542b71b10cb34e99080acd7 (diff)
parent0368127976bda29d35eed788edfe74644ecd3845 (diff)
chore(3p/exwm): Subtree EXWM ... again
Upstream EXWM is now sort-of unmaintained[0], but some important PRs
are pending[1] which I would like to absorb here somehow.

[0]: https://github.com/ch11ng/exwm/issues/845
[1]: https://github.com/ch11ng/exwm/pull/848

git-subtree-dir: third_party/exwm
git-subtree-mainline: 7894d7e178ac542f2542b71b10cb34e99080acd7
git-subtree-split: 0368127976bda29d35eed788edfe74644ecd3845
Change-Id: I078358c0ea1d2bac99111748ce9c137d2804ac4e
Diffstat (limited to 'third_party/exwm/README.md')
-rw-r--r--third_party/exwm/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/third_party/exwm/README.md b/third_party/exwm/README.md
new file mode 100644
index 0000000000..6d7e0dd1ff
--- /dev/null
+++ b/third_party/exwm/README.md
@@ -0,0 +1,21 @@
+# 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/ch11ng/xelb).
+It features:
++ Fully keyboard-driven operations
++ Hybrid layout modes (tiling & stacking)
++ Dynamic workspace support
++ ICCCM/EWMH compliance
++ (Optional) RandR (multi-monitor) support
++ (Optional) Builtin system tray
++ (Optional) Builtin input method
+
+Please check out the
+[screenshots](https://github.com/ch11ng/exwm/wiki/Screenshots)
+to get an overview of what EXWM is capable of,
+and the [user guide](https://github.com/ch11ng/exwm/wiki)
+for a detailed explanation of its usage.
+
+**Note**: If you install EXWM from source, it's recommended to install
+XELB also from source (otherwise install both from GNU ELPA).