[exwm] Adjust layer README to match current standards

This commit is contained in:
Maximilian Wolff 2021-04-19 23:04:38 +02:00
parent a664569a48
commit 2e02ac0a31
No known key found for this signature in database
GPG Key ID: 2DD07025BFDBD89A
1 changed files with 19 additions and 21 deletions

View File

@ -1,13 +1,18 @@
* EXWM contribution layer for Spacemacs
#+TITLE: EXWM layer
** Table of Contents :TOC@4:
- [[#exwm-contribution-layer-for-spacemacs][EXWM contribution layer for Spacemacs]]
- [[#description][Description]]
- [[#install][Install]]
- [[#note-about-display-managers][Note about Display Managers]]
- [[#not-having-display-managers][Not having Display Managers]]
- [[#osx][OSX]]
- [[#key-bindings][Key bindings]]
#+TAGS: layer|tool
[[file:img/spacemacsOS.jpg]]
* Table of Contents :TOC_5_gh:noexport:
- [[#description][Description]]
- [[#features][Features:]]
- [[#install][Install]]
- [[#layer][Layer]]
- [[#note-about-display-managers][Note about Display Managers]]
- [[#not-having-display-managers][Not having Display Managers]]
- [[#osx][OSX]]
- [[#key-bindings][Key bindings]]
** Description
The time has arrived when one can finally use Emacs as a Window Manager, long
@ -27,19 +32,15 @@ awesome and having nice defaults would make more people dive into it and the
project would receive more attention and contributions which will only make it
more awesome, so if you try it and like it, share it!
This is how it looks like:
[[img/spacemacsOS.jpg]]
** Features:
- Support for using Spacemacs as window manager
** Install
To use this contribution add it to your =~/.spacemacs=
#+begin_src emacs-lisp
(setq-default dotspacemacs-configuration-layers '(exwm))
#+end_src
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =exwm= to the existing =dotspacemacs-configuration-layers= list in this
file.
*** Note about Display Managers
This is most common among Ubuntu and derivative users:
LightDM, GDM, and other Display managers that need a session file will need you
@ -50,19 +51,16 @@ make sure the [[file:files/exwm-start][exwm-start script]] is in your PATH, you
select the EXWM session instead of the Ubuntu one and you should be alright.
*** Not having Display Managers
If you use Arch, Gentoo, or any other Linux, most probably you'll start your
configurations via a ~.xinitrc~ file, just append ~exwm-start~ to the end of
that file and you should be fine. I do recommend to check the [[https://github.com/ch11ng/exwm/wiki][EXWM Wiki]] for more
details.
*** OSX
If you are an OSX user, please report back on whether this works with xQuartz,
always back up your data before attempting to try stuff like this.
** Key bindings
As other window managers the ~s~ or *Super* key (Windows Key) is the one that
is the prefix to every action. We'll use a lot of ~s~.