config/README.org

#+title: Cross-Platform Configuration Files

This is a list of cross-platform configuration files which can be placed in
~.config~ directory and enabled at will.

* Installation

Install all the packages listed below. Then,
#+begin_src
cd ~/.config
git init
git remote add origin $SOURCE
git pull origin main
#+end_src

** Doom emacs

Install via (can also be placed in ~.emacs~ directory)
#+begin_src bash
git clone --depth 1 https://github.com/doomemacs/doomemacs ~/.config/emacs
~/.config/emacs/bin/doom sync
~/.config/emacs/bin/doom env
#+end_src

** Fish

Install and set the default shell to ~fish~.

** Utilities

- ~kando~: Pie menu

  Note the complicated key binding in the ~kando~ menu configuration. This is
  used for MacOS and desktop environments where some keys cannot bind to a
  command (e.g. Wacom tablets)

- ~alacritty~: terminal emulator

  Note that in order to set this as the default terminal, you may need to put
  the following in ~~/.config/kdeglobals~:
  #+begin_src
  [General]
  TerminalApplication
  #+end_src
- ~mpd~: Music player daemon
  #+begin_src sh
systemctl enable --user mpd
systemctl start --user mpd
  #+end_src
  Optionally, install ~mpc~
- ~cantata~: Controls mpd (other clients are acceptable too)
- ~btop~/~htop~: Process monitor

*** Screenfetch

- ~neofetch~: Screenfetch
- ~macchina~ (aur): Another screenfetch

* Dot Files

All the configurations which must appear as dot files are not included:
- ~.bashrc~
- ~.vimrc~: Workaround is to install NeoVim
- ~.spacemacs~
The following default files are not included for the same reason:
- ~.astylerc~
- ~.clang-format~
- ~.latexmkrc~