aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 21 insertions, 32 deletions
diff --git a/README.md b/README.md
index d561df8..3076d0e 100644
--- a/README.md
+++ b/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 @@ consult your distro's package list for specific package names.
### 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,38 +51,37 @@ consult your distro's package list for specific package names.
## 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).
-2. clone this repository to `~/.xmonad`
+1. install xmonad through your package manager.
- ```
- $ git clone https://git.aaoth.xyz/xmonad-config.git ~/.xmonad
- ```
-3. update and sync submodules
+2. clone this repository to `~/.config/xmonad`
```
- $ git submodule init
- $ git submodule update
+ $ git clone https://git.aaoth.xyz/xmonad-config.git ~/.config/xmonad
```
-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`.
- ```
- $ stack install
- ```
-5. copy `xmonad.desktop` file to `/usr/share/xsessions` if you are using
+3. copy `example/xmonad.desktop` file to `/usr/share/xsessions` if you are using
display manager
```
$ sudo cp xmonad.desktop /usr/share/xsessions
```
-6. log in and enjoy
+
+ otherwise, add this to your `~/.xinitrc`:
+
+ ```
+ exec xmonad
+ ```
+
+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/
[3]:https://gitlab.com/dwt1/dmscripts