]>
Commit | Line | Data |
---|---|---|
1 | # Dotfiles | |
2 | ||
3 | To set up run `./install` | |
4 | ||
5 | It 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 | ||
23 | The scripts here have support for `brew`, `pacman`, or `apt`. | |
24 | Install brew with: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"` | |
25 | ||
26 | It might also be a good idea to install the xcode command line tools with `xcode-select --install` | |
27 | ||
28 | ## Provisioning | |
29 | ||
30 | These dotfiles include some provisioning scripts for `brew`, `pacman`, and `apt`. | |
31 | ||
32 | To 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 | ||
39 | To see what each recipe installs, check the files under `provisioning/` | |
40 | ||
41 | ## Local zshrc | |
42 | ||
43 | For local modifications to the zshrc create `~/.zshrc.local`. | |
44 | ||
45 | ## Local vim overrides | |
46 | ||
47 | For local modifications to your neovim init create `~/.config/nvim/lua/init_local.lua` | |
48 | ||
49 | ## Environment modification | |
50 | ||
51 | In order to specify the environment in the prompt, create a function | |
52 | called `env_info_provider` and echo your environment details (eg. | |
53 | `dev`, `staging`, `production`) | |
54 | ||
55 | ## LSP & Neovim | |
56 | ||
57 | For the LSP to work, some external dependencies might be needed. As some of | |
58 | these depend on what version asdf has loaded, or specific projects, they're | |
59 | not included by default. | |
60 | ||
61 | See [the nvim-lspconfig docs][lsp] for more info. | |
62 | [lsp]: https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md | |
63 | ||
64 | ## Private Files | |
65 | ||
66 | There are some potentially sensitive files included. They're PGP encrypted. If | |
67 | you need them you can run `./sensitive`. To update them if they change, | |
68 | run `./sensitive update` instead. | |
69 | ||
70 | For passwords, make sure you have setup the `pass` store. |