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