about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--.gitignore2
-rw-r--r--README.md13
-rw-r--r--README.org15
-rw-r--r--exwm-workspace.el1
4 files changed, 18 insertions, 13 deletions
diff --git a/.gitignore b/.gitignore
index c531d9867f6c..9e4b0ee5b48e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,3 @@
 *.elc
+*-pkg.el
+*-autoloads.el
diff --git a/README.md b/README.md
deleted file mode 100644
index 5d18fa6c85ab..000000000000
--- a/README.md
+++ /dev/null
@@ -1,13 +0,0 @@
-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 operation
-+ Hybrid layout modes (tiling & stacking)
-+ Workspace support
-+ ICCCM/EWMH compliance
-+ Basic RandR support (optional)
-
-Please check the [wiki](https://github.com/ch11ng/exwm/wiki) for more details.
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).
diff --git a/exwm-workspace.el b/exwm-workspace.el
index 6f76d2061ad6..03972b407849 100644
--- a/exwm-workspace.el
+++ b/exwm-workspace.el
@@ -101,6 +101,7 @@
 (defvar exwm-workspace-show-all-buffers nil
   "Non-nil to show buffers on other workspaces.")
 
+;;;###autoload
 (defun exwm-workspace-switch (index &optional force)
   "Switch to workspace INDEX. Query for INDEX if it's not specified.