Merge branch 'main' of git.sr.ht:~rbdr/dotfiles

[rbdr/dotfiles] / README.md

diff --git a/README.md b/README.md
index ba0bf118bf978604b79404d81c15f9386b915ab4..e6f079653c756dee4200f0559d19055f290d143b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,15 +4,30 @@ To set up run `./install`
 
 It provides configuration for:
 
 
 It provides configuration for:
 

+* nvim
+* tmux

 * zsh
 * zsh

+* git
+* ripgrep
+* tmuxp
+* kitty
+* karabiner

 * weechat
 * weechat

-* vim

 * nethack
 * terminfo italics support
 * 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
 
 
 ## 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 <recipe>` where `<recipe>` is one of:
 
 
 To set up run `./provision <recipe>` where `<recipe>` 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`.
 
 
 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`)
 ## 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.