]> git.r.bdr.sh - rbdr/dotfiles/blame - README.md
Update nethack 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
a78545ae 7* nvim
650123f4 8* tmux
fe9e7669 9* zsh
650123f4 10* git
650123f4
RBR
11* ripgrep
12* tmuxp
13* kitty
14* karabiner
fe9e7669 15* weechat
fe9e7669
BB
16* nethack
17* terminfo italics support
a78545ae
RBR
18* yabai & skhdc
19* asdf
8bf2adee 20
650123f4
RBR
21## Prerequisites
22
a78545ae 23The scripts here have support for `brew`, `pacman`, or `apt`.
650123f4
RBR
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
8bf2adee
RBR
28## Provisioning
29
a78545ae 30These dotfiles include some provisioning scripts for `brew`, `pacman`, and `apt`.
8bf2adee
RBR
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
77d9cf9a
RBR
45## Local vim overrides
46
47For local modifications to your neovim init create `~/.config/nvim/lua/init_local.lua`
48
8bf2adee
RBR
49## Environment modification
50
51In order to specify the environment in the prompt, create a function
52called `env_info_provider` and echo your environment details (eg.
53`dev`, `staging`, `production`)
00b5fea6
RBR
54
55## CoC & Neovim
56
57Additional scripts are providing for updating extensions in neovim.
58
59After setting up nvim and installing plugins, you can run
60`./add-coc-vim-extensions` to automatically add the extensions.