M README.md → README.md

@@ -1,8 +1,6 @@
 # xmonad config
 
-this is rather simple xmobar config of mine. it is based primarily on
-[distrotube's][1] config, but i changed quite a few things and added toki pona
-fonts.
+this is rather simple xmobar config of mine. see xmonad.hs for details.
 
 ![preview](doc/preview.jpg)
 
@@ -25,28 +23,20 @@ * libxpm-dev
 
 ### software
 
-* [stack][2]
+these are not strict dependencies. it's just that keybindings are
+set to spawn them. feel free to change any of these to your liking.
+
 * dmenu (run launcher)
 * alacritty (terminal emulator)
-* dunst (notification daemon)
-* picom (compositor)
-* feh (wallpaper setter)
-* trayer (tray manager)
 
 #### optional
 
-* [dmscripts][3]
-* lxsession (polkit stuff)
-* NetworkManager (nm-applet)
-* volumeicon (tray volume icon)
-* kbdd (per-window keyboard layout)
-* amfora (gemini client)
 * thunar (file manager)
-* brave (web browser)
+* firefox (web browser)
 * mpv (media player)
 * moc (music on console)
 * qalculate-gtk (calculator)
-* geary (mail client)
+* thunderbird (mail client)
 
 ### fonts
 
@@ -61,37 +51,36 @@ * Font Awesome Brands
 
 ## installation
 
-1. install all dependencies from the list.
+this guide assumes that xmonad-0.17 is available from your distro's repos.
+if it's not the case, the better option is to use stack to build latest xmonad,
+xmonad-contrib and xmobar (see example/ for details).
+
+1. install xmonad through your package manager.
 
-2. clone this repository to `~/.xmonad`
+2. clone this repository to `~/.config/xmonad`
 
     ```
-    $ git clone https://git.aaoth.xyz/xmonad-config.git ~/.xmonad
+    $ git clone https://git.aaoth.xyz/xmonad-config.git ~/.config/xmonad
     ```
-3. update and sync submodules
 
-    ```
-    $ git submodule init
-    $ git submodule update
-    ```
-4. install with stack (this can take some time, since it's compiling from source).
-make sure that you have `~/.local/bin` in your `PATH`.
+3. copy `example/xmonad.desktop` file to `/usr/share/xsessions` if you are using
+display manager
 
     ```
-    $ stack install
+    $ sudo cp xmonad.desktop /usr/share/xsessions
     ```
-5. copy `xmonad.desktop` file to `/usr/share/xsessions` if you are using
-display manager
+
+    otherwise, add this to your `~/.xinitrc`:
 
     ```
-    $ sudo cp xmonad.desktop /usr/share/xsessions
+    exec xmonad
     ```
-6. log in and enjoy
+
+4. log in and enjoy
 
 ## keybindings
 
 *work in progress*
-
 
 [1]:https://gitlab.com/dwt1/dotfiles/-/tree/master/.xmonad
 [2]:https://docs.haskellstack.org/en/stable/README/

A example/README.md

@@ -0,0 +1,24 @@
+if xmonad >=0.17 isn't available from your distro's package manager,
+the better option would be to use stack to build xmonad.
+
+install stack using your package manager or consider [stack's documentation][1].
+
+[1]:https://docs.haskellstack.org/en/stable/README/
+
+you need to copy `example/stack.yml.example` to
+`~/.config/xmonad/stack.yml`. and to copy `example/build` script to
+`~/.config/xmonad/build`. these are needed for xmonad to use stack for
+rebuilding.
+
+```
+$ cp ~/.config/xmonad/example/stack.yml.example ~/.config/xmonad/stack.yaml
+$ cp ~/.config/xmonad/example/build ~/.config/xmonad/build
+```
+
+also you need to fetch bunlded submodules using git (or provide xmonad-git and
+xmonad-contrib-git using some other way).
+
+```
+$ git submodule init
+$ git submodule update
+```