Use nvim as git editor

[rbdr/dotfiles] / README.md

diff --git a/README.md b/README.md
index 95f8cd770c1bfee32ed68e1a9d20fb819e97ef3f..352c1f1f3e4c70ad2e054ee57acfe6a18a194e8b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,48 @@
-dotfiles
-========
+# Dotfiles

 
 

-My Dot Files
\ No newline at end of file
+To set up run `./install`
+
+It provides configuration for:
+
+* vim / nvim
+* tmux
+* zsh
+* git
+* ctags
+* ripgrep
+* tmuxp
+* kitty
+* karabiner
+* weechat
+* 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`.
+
+To set up run `./provision <recipe>` where `<recipe>` is one of:
+
+* `essential`
+* `nice`
+* `cask_essential` (only `brew`)
+* `cask_nice` (only `brew`)
+
+To see what each recipe installs, check the files under `provisioning/`
+
+## Local zshrc
+
+For local modifications to the zshrc create `~/.zshrc.local`.
+
+## 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`)