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