X-Git-Url: https://git.r.bdr.sh/rbdr/dotfiles/blobdiff_plain/0fb584cff43a80a74d34848518456b427b538575..9fd81304120d4977a56c9d33954367a927da1746:/README.md diff --git a/README.md b/README.md index ba0bf11..e6f0796 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,30 @@ To set up run `./install` It provides configuration for: +* nvim +* tmux * zsh +* git +* ripgrep +* tmuxp +* kitty +* karabiner * weechat -* vim * nethack * terminfo italics support +* yabai & skhdc +* asdf + +## Prerequisites + +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: @@ -27,8 +42,19 @@ 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`) + +## CoC & Neovim + +Additional scripts are providing for updating extensions in neovim. + +After setting up nvim and installing plugins, you can run +`./add-coc-vim-extensions` to automatically add the extensions.