Update submodules, error provision if no file

[rbdr/dotfiles] / README.md

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

 
 

-My Dot Files
\ No newline at end of file
+To set up run `install_dotfiles`
+
+It provides configuration for:
+
+* zsh
+* weechat
+* vim
+* nethack
+* terminfo italics support
+
+## 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`)