From 4c7d3eeaf792bcef3c8cab4ffac04360e41a531c Mon Sep 17 00:00:00 2001 From: la-ninpre Date: Fri, 24 Jun 2022 13:59:55 +0300 Subject: readme: update to the latest config oops, should've done it earlier. also added readme for stack-based approach. --- README.md | 53 +++++++++++++++++++++-------------------------------- example/README.md | 24 ++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 32 deletions(-) create mode 100644 example/README.md 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 diff --git a/example/README.md b/example/README.md new file mode 100644 index 0000000..62958ce --- /dev/null +++ b/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 +``` -- cgit v1.2.3