dotfiles/README.org

#+TITLE:   Dotfiles
#+DATE:    February 4, 2020
#+SINCE:   {replace with next tagged release version}
#+STARTUP: inlineimages nofold

* Table of Contents :TOC_3:noexport:
- [[#description][Description]]
  - [[#maintainers][Maintainers]]
- [[#prerequisites][Prerequisites]]
- [[#applications-installed-by-script][Applications installed by script]]
  - [[#applications][Applications]]
  - [[#fonts][Fonts]]
  - [[#libraries][Libraries]]
    - [[#python][Python]]
  - [[#lsp-backends][LSP Backends]]
- [[#configured-applications-also-installed-by-script][Configured Applications (also installed by script)]]
- [[#configured-locales][Configured Locales]]
- [[#golang][Golang]]
- [[#shell][Shell]]
- [[#fish][Fish]]
    - [[#theme][Theme]]
    - [[#package-manager][Package Manager]]
    - [[#packages][Packages]]
- [[#neovim][Neovim]]
  - [[#theme-1][Theme]]
  - [[#plugin-manager][Plugin Manager]]
  - [[#plugins][Plugins]]
    - [[#general][General]]
    - [[#programming][Programming]]
    - [[#ui][UI]]
- [[#npm][NPM]]
  - [[#packages-1][Packages]]
- [[#zsh][Zsh]]
  - [[#theme-2][Theme]]
  - [[#plugin-manager-1][Plugin Manager]]
  - [[#plugins-1][Plugins]]
- [[#configuration][Configuration]]
  - [[#installation][Installation]]
  - [[#find--delete-orphaned-symlinks][Find & delete orphaned symlinks]]
- [[#license][License]]

* Description
A repository of my personal configuration files.

** Maintainers
+ [[https://github.com/alrayyes][@alrayyes]]

* Prerequisites
- [[https://www.archlinux.org/][Arch Linux]]
- [[https://fishshell.com/][fish shell]]
- [[https://github.com/Jguer/yay][yay]]

* Applications installed by script
** Applications
- [[https://github.com/sharkdp/bat][bat]]
- [[https://dystroy.org/broot/][broot]]
- [[https://brave.com/][brave]]
- [[https://github.com/caffeine-ng/caffeine-ng][caffeine-ng]]
- [[https://the.exa.website/][exa]]
- [[https://github.com/pixelb/fslint][fslint]]
- [[https://github.com/junegunn/fzf][fzf]]
- [[https://gnupg.org/][gnupg]]
- [[https://graphviz.org/][graphviz]]
- [[https://imagemagick.org/index.php][ImageMagick]]
- [[http://isync.sourceforge.net/mbsync.html][isync]]
- [[https://github.com/canonical/lightdm][LightDM]]
- [[https://github.com/internalfx/mailcap][mailcap]]
- [[https://mpv.io/][mpv]]
- [[https://github.com/dylanaraps/neofetch][neofetch]]
- [[https://www.npmjs.com/get-npm][npm]]
- [[https://github.com/cdemoulins/pamixer][pamixer]]
- [[https://pandoc.org/][Pandoc]]
- [[https://github.com/altdesktop/playerctl][Playerctl]]
- [[https://www.freedesktop.org/wiki/Software/PulseAudio/][Pulseaudio]]
- [[https://github.com/GeorgeFilipkin/pulsemixer][pulsemixer]]
- [[https://www.python.org/][Python]]
- [[https://github.com/dylanaraps/pywal][pywal]]
- [[https://github.com/BurntSushi/ripgrep][ripgrep]]
- [[https://github.com/Spotifyd/spotifyd][Spotifyd]]
- [[http://www.gnu.org/software/stow/][stow]]
- [[https://github.com/muennich/sxiv][sxiv]]
- [[https://github.com/tldr-pages/tldr][tldr]]
- [[https://github.com/sargon/trayer-srg][trayer-srg]]
- [[https://www.freedesktop.org/wiki/Software/udisks/][udisks]]
- unclutter
- [[https://github.com/jcs/xbanish][xbanish]]
- [[https://www.x.org/releases/X11R7.5/doc/man/man1/xprop.1.html][xprop]]
- [[https://github.com/stoeckmann/xwallpaper][xwallpaper]]
- [[https://yarnpkg.com/][yarn]]
- [[https://pwmt.org/projects/zathura/][zathura]]
** Fonts
- [[https://www.dafont.com/linux-libertine.font][Linux Libertine]]
- [[https://www.google.com/get/noto/][Noto Fonts]]
- [[https://www.google.com/get/noto/help/emoji/][Noto Color Emoji]]
- Nerd patched [[https://sourcefoundry.org/hack/][Hack]]
** Libraries
*** st / dmenu / dwm
- [[#+title: https://aur.archlinux.org/packages/libxft-bgra/][libxft-bgra]]
** LSP Backends
- [[https://github.com/mads-hartmann/bash-language-server][bash-language-server]]
- [[https://github.com/MaskRay/ccls][ccls]]
- [[https://github.com/felixfbecker/php-language-server][php-language-server]]
- [[https://github.com/Microsoft/python-language-server][python-language-server]]
- [[https://github.com/theia-ide/typescript-language-server][typescript-language-server]]
- [[https://github.com/vscode-langservers/vscode-css-languageserver][vscode-css-languageserver]]
- [[https://github.com/vscode-langservers/vscode-html-languageserver][vscode-html-languageserver]]
- [[https://github.com/bmewburn/vscode-intelephense][vscode-intelephense]]

* Configured Applications (also installed by script)
- [[https://github.com/alacritty/][alacritty]]
- [[https://github.com/baskerville/bspwm][bspwm]]
- [[https://github.com/xgi/castero][castero]]
- [[https://github.com/hlissner/doom-emacs][Doom Emacs]]
- [[https://dunst-project.org/][dunst]]
- [[https://firejail.wordpress.com/][firejail]]
- [[https://fishshell.com/][fish]]
- [[https://git-scm.com/][git]]
- [[https://github.com/gokcehan/lf][lf]]
- [[https://github.com/phuhl/linux_notification_center][Lintux Notification Center]]
- [[https://www.musicpd.org/][mpd]]
- [[https://mpv.io/][mpv]]
- [[https://rybczak.net/ncmpcpp/][ncmpcpp]]
- [[https://neomutt.org/][neomutt]]
- [[https://neovim.io/][neovim]]
- [[https://github.com/yshui/picom][picom]]
- [[http://jonls.dk/redshift/][redshift]]
- [[https://github.com/baskerville/sxhkd][sxhkd]]
- [[https://tmux.github.io/][tmux]]
- [[https://gitlab.com/ajak/tuir][tuir]]
- [[https://weechat.org/][weechat]]

* Configured Locales
- [[https://ftp.gnu.org/gnu/aspell/dict/en][aspell-en]]
- hunspell-en_GB
- hunspell-en_US
- hunspell_nl

* Golang
- [[https://golang.org/][golang]]
- [[https://github.com/golangci/golangci-lint][golangci-lint]]

* Shell
- [[https://github.com/mvdan/sh][shfmt]]
- [[https://www.shellcheck.net/][shellcheck]]

* Fish
*** Theme
- [[https://starship.rs/][starship]]
*** Package Manager
- [[https://github.com/oh-my-fish/oh-my-fish][oh-my-fish]]
*** Packages
- [[https://github.com/patrickf3139/Colored-Man-Pages][colored-man-pages]]
- [[https://github.com/oh-my-fish/plugin-extract][extract]]
- [[https://github.com/jethrokuan/fzf][fzf]]
- [[https://github.com/oh-my-fish/plugin-gi][gi]]
- [[https://github.com/oh-my-fish/plugin-git-flow][git-flow]]
- [[https://github.com/oh-my-fish/plugin-wttr][wttr]]

* Neovim
** Theme
- [[https://github.com/gruvbox-community/gruvbox][gruvbox]]
** Plugin Manager
- [[https://github.com/junegunn/vim-plug][vim-plug]]
** Plugins
*** General
- [[https://github.com/bling/vim-bufferline][bling/vim-bufferline]]
- [[https://github.com/ctrlpvim/ctrlp.vim][ctrlp/ctrlp.vim]]
- [[https://github.com/easymotion/vim-easymotion][easymotion/vim-easymotion]]
- [[https://github.com/farmergreg/vim-lastplace][farmergreg/vim-lastplace]]
- [[https://github.com/junegunn/fzf.vim][junegunn/fzf.vim]]
- [[https://github.com/mbbill/undotree][mbbill/undotree]]
- [[https://github.com/mhinz/vim-signify][mhinz/vim-signify]]
- [[https://github.com/myusuf3/numbers.vim][myusuf3/numbers.vim]]
- [[https://github.com/preservim/nerdtree][preservim/nerdtree]]
- [[https://github.com/rhysd/conflict-marker.vim][rhysd/conflict-marker.vim]]
- [[https://github.com/terryma/vim-multiple-cursors][terryma/vim-multiple-cursors]]
- [[https://github.com/tpope/vim-abolish][tpope/vim-abolish]]
- [[https://github.com/tpope/vim-surround][tpope/vim-surround]]
- [[https://github.com/vim-airline/vim-airline][vim-airline/vim-airline]]
*** Programming
- [[https://github.com/airblade/vim-gitgutter][airblade/vim-gitgutter]]
- [[https://github.com/alvan/vim-closetag][alvan/vim-closetag]]
- [[https://github.com/dense-analysis/ale][dense-analysis/ale]]
- [[https://github.com/fatih/vim-go][fatih/vim-go]]
- [[https://github.com/godlygeek/tabular][godlygeek/tabular]]
- [[https://github.com/neoclide/coc.nvim][neoclice/coc.nvim]]
- [[https://github.com/RRethy/vim-hexokinase][RRethy/vim-hexokinase]]
- [[https://github.com/sheerun/vim-polyglot][sheerun/vim-polyglot]]
- [[https://github.com/tpope/vim-commentary][tpope/vim-commentary]]
- [[https://github.com/tpope/vim-fugitive][tpope/vim-fugitive]]
- [[https://github.com/tpope/vim-unimpaired][tpope/vim-unimpaired]]
- [[https://github.com/Xuyuanp/nerdtree-git-plugin][Xuyuanp/nerdtree-git-plugin]]
-[[https://github.com/Yggdroot/indentLine][ Yggdroot/indentLine]]
*** UI
- [[https://github.com/morhetz/gruvbox][morhetz/gruvbox]]
- [[https://github.com/ryanoasis/vim-devicons][ryanoasis/vim-devicons]]

* NPM
** Packages
- [[https://github.com/GoogleChrome/lighthouse][lighthouse]]

* Zsh
** Theme
- [[https://starship.rs/][starship]]
** Plugin Manager
- [[https://github.com/zplug/zplug][zplug]]
** Plugins
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/archlinux][archlinux]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/composer][composer]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/docker][docker]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/docker-compose][docker-compose]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/extract][extract]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/fzf][fzf]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/git][git]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/gitignore][gitignore]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/pass][pass]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/ripgrep][ripgrep]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/rsync][rsync]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/sudo][sudo]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/systemd][systemd]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/tmux][tmux]]
- [[https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/vi-mode][vi-mode]]
- [[https://github.com/zsh-users/zsh-autosuggestions][zsh-autosuggestions]]
- [[https://github.com/zsh-users/zsh-syntax-highlighting][zsh-syntax-highlighting]]

* Configuration
** Installation
#+BEGIN_SRC shell
./install
#+END_SRC
** Find & delete orphaned symlinks
#+BEGIN_SRC shell
./clean-dead-symlinks
#+END_SRC

* License
:PROPERTIES:
:CUSTOM_ID: license
:END:
This theme is released under the MIT License. For more information read
the [[file:LICENSE.org][license]].

#  LocalWords:  Neovim