X-Git-Url: https://git.r.bdr.sh/rbdr/dotfiles/blobdiff_plain/fe9e7669cf3a5c546ad77647532379d1e9e2ea73..8bf2adeececb300944479c7a07ff8c6c0af9f4a5:/README.md diff --git a/README.md b/README.md index 987bbfe..4d64750 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,26 @@ It provides configuration for: * vim * nethack * terminfo italics support + +## Provisioning + +These dotfiles include some provisioning scripts for `brew` and `apt`. + +To set up run `./provision ` where `` 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`)