From 5e2c9ce01d092e2292b634b93641207e0e18d75b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20Ke=C3=9Fler?= Date: Sun, 17 Jul 2022 10:57:25 +0200 Subject: [PATCH] update README --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 748661d..49ba539 100644 --- a/README.md +++ b/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/