update README
This commit is contained in:
parent
b74a4e9ef3
commit
5e2c9ce01d
1 changed files with 11 additions and 7 deletions
18
README.md
18
README.md
|
@ -1,10 +1,13 @@
|
|||
# Usage
|
||||
# `xmonad-custom`: Custom modules for my xmonad configuration
|
||||
|
||||
Install via stack similar as xmonad and xmonad-contrib, see e.g.
|
||||
https://brianbuccola.com/how-to-install-xmonad-and-xmobar-via-stack/
|
||||
## Usage
|
||||
|
||||
# Goals of this setup
|
||||
## Design
|
||||
Install via stack similar as xmonad and xmonad-contrib,
|
||||
see e.g. [brianbuccola][this guide].
|
||||
Write `xmonad.hs` as glue code to import modules.
|
||||
|
||||
## Goals of this setup
|
||||
### Design
|
||||
- Keybindings optimized for neo keyboard layout:
|
||||
- positional keybindings taken from default XMonad config,
|
||||
e.g. now `n` and `d` are used to rotate through workspaces,
|
||||
|
@ -24,7 +27,7 @@ https://brianbuccola.com/how-to-install-xmonad-and-xmobar-via-stack/
|
|||
(still many missing)
|
||||
- Use [polybar][PolyBar] as status bar
|
||||
|
||||
## Implementational
|
||||
### Implementational
|
||||
- Use [ezconfig][EZConfig] for all bindings to simplify code.
|
||||
- Use [submap][Submap] for menus.
|
||||
- separation into multiple modules to clean up the main `xmonad.hs` config file
|
||||
|
@ -42,7 +45,7 @@ https://brianbuccola.com/how-to-install-xmonad-and-xmobar-via-stack/
|
|||
In particular, no [build-script][custom build script] is needed to build `xmonad`.
|
||||
- Use [xmonad-dbus][xmonad-dbus] for communication with PolyBar.
|
||||
|
||||
# Non-goals
|
||||
## Non-goals
|
||||
- Write a library that is directly usable for others.
|
||||
This is for personal use, although you are of course invited to reuse/adapt/fork this
|
||||
- Complete separation of code and configuration.
|
||||
|
@ -61,3 +64,4 @@ https://brianbuccola.com/how-to-install-xmonad-and-xmobar-via-stack/
|
|||
[submap]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Actions-Submap.html
|
||||
[xmonad-dbus]: https://github.com/troydm/xmonad-dbus
|
||||
[polybar]: https://github.com/polybar/polybar
|
||||
[brianbuccola]: https://brianbuccola.com/how-to-install-xmonad-and-xmobar-via-stack/
|
||||
|
|
Loading…
Reference in a new issue