Use shift modifier to create kitty instances

[rbdr/dotfiles] / README.md

diff --git a/README.md b/README.md
index 4d64750300ef6a459c29d40321b9cc397e03b4d2..3456972f7c2e728160a7d62ce62fc207e5796389 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,15 +1,29 @@
 # Dotfiles
 
-To set up run `install_dotfiles`
+To set up run `./install`
 
 It provides configuration for:
 
+* vim / nvim
+* tmux
 * zsh
+* git
+* ctags
+* ripgrep
+* tmuxp
+* kitty
+* karabiner
 * weechat
-* vim
 * nethack
 * terminfo italics support
 
+## Prerequisites
+
+The scripts here assume either `brew` or `apt` are installed.
+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`.
@@ -32,3 +46,10 @@ For local modifications to the zshrc create `~/.zshrc.local`.
 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.