X-Git-Url: https://git.r.bdr.sh/rbdr/dotfiles/blobdiff_plain/650123f4269e48a8166fb53a59379b55396e8fce..f9f05d0ffbf5a6972c528fff044b5e107a856262:/README.md diff --git a/README.md b/README.md index 352c1f1..3735424 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,10 @@ To set up run `./install` It provides configuration for: -* vim / nvim +* nvim * tmux * zsh * git -* ctags * ripgrep * tmuxp * kitty @@ -16,17 +15,19 @@ It provides configuration for: * weechat * nethack * terminfo italics support +* yabai & skhdc +* asdf ## Prerequisites -The scripts here assume either `brew` or `apt` are installed. +The scripts here have support for `brew`, `pacman`, or `apt`. Install brew with: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"` It might also be a good idea to install the xcode command line tools with `xcode-select --install` ## Provisioning -These dotfiles include some provisioning scripts for `brew` and `apt`. +These dotfiles include some provisioning scripts for `brew`, `pacman`, and `apt`. To set up run `./provision ` where `` is one of: @@ -41,8 +42,29 @@ To see what each recipe installs, check the files under `provisioning/` For local modifications to the zshrc create `~/.zshrc.local`. +## Local vim overrides + +For local modifications to your neovim init create `~/.config/nvim/lua/init_local.lua` + ## Environment modification In order to specify the environment in the prompt, create a function called `env_info_provider` and echo your environment details (eg. `dev`, `staging`, `production`) + +## LSP & Neovim + +For the LSP to work, some external dependencies might be needed. As some of +these depend on what version asdf has loaded, or specific projects, they're +not included by default. + +See [the nvim-lspconfig docs][lsp] for more info. +[lsp]: https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md + +## Private Files + +There are some potentially sensitive files included. They're PGP encrypted. If +you need them you can run `./sensitive`. To update them if they change, +run `./sensitive update` instead. + +For passwords, make sure you have setup the `pass` store.