]> git.r.bdr.sh - rbdr/dotfiles/blame_incremental - README.md
Update docs
[rbdr/dotfiles] / README.md
... / ...
CommitLineData
1# Dotfiles
2
3To set up run `./install`
4
5It provides configuration for:
6
7* nvim
8* tmux
9* zsh
10* git
11* ripgrep
12* tmuxp
13* kitty
14* karabiner
15* weechat
16* nethack
17* terminfo italics support
18* yabai & skhdc
19* asdf
20
21## Prerequisites
22
23The scripts here have support for `brew`, `pacman`, or `apt`.
24Install brew with: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
25
26It might also be a good idea to install the xcode command line tools with `xcode-select --install`
27
28## Provisioning
29
30These dotfiles include some provisioning scripts for `brew`, `pacman`, and `apt`.
31
32To set up run `./provision <recipe>` where `<recipe>` is one of:
33
34* `essential`
35* `nice`
36* `cask_essential` (only `brew`)
37* `cask_nice` (only `brew`)
38
39To see what each recipe installs, check the files under `provisioning/`
40
41## Local zshrc
42
43For local modifications to the zshrc create `~/.zshrc.local`.
44
45## Environment modification
46
47In order to specify the environment in the prompt, create a function
48called `env_info_provider` and echo your environment details (eg.
49`dev`, `staging`, `production`)
50
51## CoC & Neovim
52
53Additional scripts are providing for updating extensions in neovim.
54
55After setting up nvim and installing plugins, you can run
56`./add-coc-vim-extensions` to automatically add the extensions.