README: Make customizations in ~/dotfiles-local

README.md

@@ -42,6 +42,8 @@ configuration options:
   the `dotfiles` repository but do not need to be symlinked in.
 * Give precedence to personal overrides which by default are placed in
   `~/dotfiles-local`
+* Please configure the `rcrc` file if you'd like to make personal
+  overrides in a different directory
 
 You can safely run `rcup` multiple times to update:
 
@@ -53,26 +55,30 @@ any new files in the repository.
 Make your own customizations
 ----------------------------
 
-Put your customizations in dotfiles appended with `.local`:
+Create a directory for your personal customizations: 
 
-* `~/.aliases.local`
+    mkdir ~/dotfiles-local
-* `~/.git_template.local/*`
+
-* `~/.gitconfig.local`
+Put your customizations in `~/dotfiles-local` appended with `.local`:
-* `~/.gvimrc.local`
+
-* `~/.psqlrc.local` (we supply a blank `.psqlrc.local` to prevent `psql` from
+* `~/dotfiles-local/aliases.local`
+* `~/dotfiles-local/git_template.local/*`
+* `~/dotfiles-local/gitconfig.local`
+* `~/dotfiles-local/gvimrc.local`
+* `~/dotfiles-local/psqlrc.local` (we supply a blank `.psqlrc.local` to prevent `psql` from
   throwing an error, but you should overwrite the file with your own copy)
-* `~/.tmux.conf.local`
+* `~/dotfiles-local/tmux.conf.local`
-* `~/.vimrc.local`
+* `~/dotfiles-local/vimrc.local`
-* `~/.vimrc.bundles.local`
+* `~/dotfiles-local/vimrc.bundles.local`
-* `~/.zshrc.local`
+* `~/dotfiles-local/zshrc.local`
-* `~/.zsh/configs/*`
+* `~/dotfiles-local/zsh/configs/*`
 
-For example, your `~/.aliases.local` might look like this:
+For example, your `~/dotfiles-local/aliases.local` might look like this:
 
     # Productivity
     alias todo='$EDITOR ~/.todo'
 
-Your `~/.gitconfig.local` might look like this:
+Your `~/dotfiles-local/gitconfig.local` might look like this:
 
     [alias]
       l = log --pretty=colored
@@ -82,7 +88,7 @@ Your `~/.gitconfig.local` might look like this:
       name = Dan Croak
       email = dan@thoughtbot.com
 
-Your `~/.vimrc.local` might look like this:
+Your `~/dotfiles-local/vimrc.local` might look like this:
 
     " Color scheme
     colorscheme github
@@ -90,16 +96,16 @@ Your `~/.vimrc.local` might look like this:
     highlight Folded  guibg=#0A0A0A guifg=#9090D0
 
 To extend your `git` hooks, create executable scripts in
-`~/.git_template.local/hooks/*` files.
+`~/dotfiles-local/git_template.local/hooks/*` files.
 
-Your `~/.zshrc.local` might look like this:
+Your `~/dotfiles-local/zshrc.local` might look like this:
 
     # load pyenv if available
     if which pyenv &>/dev/null ; then
       eval "$(pyenv init -)"
     fi
 
-Your `~/.vimrc.bundles.local` might look like this:
+Your `~/dotfiles-local/vimrc.bundles.local` might look like this:
 
     Plug 'Lokaltog/vim-powerline'
     Plug 'stephenmckinney/vim-solarized-powerline'
@@ -107,22 +113,22 @@ Your `~/.vimrc.bundles.local` might look like this:
 zsh Configurations
 ------------------
 
-Additional zsh configuration can go under the `~/.zsh/configs` directory. This
+Additional zsh configuration can go under the `~/dotfiles-local/zsh/configs` directory. This
 has two special subdirectories: `pre` for files that must be loaded first, and
 `post` for files that must be loaded last.
 
-For example, `~/.zsh/configs/pre/virtualenv` makes use of various shell
+For example, `~/dotfiles-local/zsh/configs/pre/virtualenv` makes use of various shell
 features which may be affected by your settings, so load it first:
 
     # Load the virtualenv wrapper
     . /usr/local/bin/virtualenvwrapper.sh
 
-Setting a key binding can happen in `~/.zsh/configs/keys`:
+Setting a key binding can happen in `~/dotfiles-local/zsh/configs/keys`:
 
     # Grep anywhere with ^G
     bindkey -s '^G' ' | grep '
 
-Some changes, like `chpwd`, must happen in `~/.zsh/configs/post/chpwd`:
+Some changes, like `chpwd`, must happen in `~/dotfiles-local/zsh/configs/post/chpwd`:
 
     # Show the entries in a directory whenever you cd in
     function chpwd {
@@ -132,16 +138,16 @@ Some changes, like `chpwd`, must happen in `~/.zsh/configs/post/chpwd`:
 This directory is handy for combining dotfiles from multiple teams; one team
 can add the `virtualenv` file, another `keys`, and a third `chpwd`.
 
-The `~/.zshrc.local` is loaded after `~/.zsh/configs`.
+The `~/dotfiles-local/zshrc.local` is loaded after `~/dotfiles-local/zsh/configs`.
 
 vim Configurations
 ------------------
 
 Similarly to the zsh configuration directory as described above, vim
-automatically loads all files in the `~/.vim/plugin` directory. This does not
+automatically loads all files in the `~/dotfiles-local/vim/plugin` directory. This does not
 have the same `pre` or `post` subdirectory support that our `zshrc` has.
 
-This is an example `~/.vim/plugin/c.vim`. It is loaded every time vim starts,
+This is an example `~/dotfiles-local/vim/plugin/c.vim`. It is loaded every time vim starts,
 regardless of the file name:
 
     # Indent C programs according to BSD style(9)