Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Document "DO NOT EDIT BELOW THIS LINE" convention

  • Loading branch information...
commit 52b2ee106e3c8c3ed36611e6e99f39d10a01bd4f 1 parent 0060e0a
@croaky croaky authored
Showing with 44 additions and 25 deletions.
  1. +44 −25 README.md
View
69 README.md
@@ -1,32 +1,39 @@
thoughtbot dotfiles
===================
+Requirements
+------------
+
+Set zsh as your login shell.
+
+ chsh -s /bin/zsh
+
Install
-------
-First, [fork this repo](https://github.com/thoughtbot/dotfiles#fork_box) on Github.
+First, [fork this repo](/thoughtbot/dotfiles#fork_box) on Github.
-Then, clone your Github fork (replace "your-github-name" with your Github name) onto your laptop and install it:
+Then, clone your Github fork onto your laptop and install it:
git clone git@github.com:your-github-name/dotfiles.git
cd dotfiles
./install.sh
-This will create symlinks for all config files in your home directory. You can
-safely run this file multiple times to update.
+This will create symlinks for config files in your home directory. If you
+include the line "DO NOT EDIT BELOW THIS LINE" anywhere in a config file, it
+will copy that file over instead of symlinking it, and it will leave
+everything above that line in your local config intact.
-There is configuration for `zsh` so switch your shell from the default `bash` to `zsh` on OS X:
-
- chsh -s /bin/zsh
+You can safely run `./install.sh` multiple times to update.
Why fork?
---------
-dotfiles are fairly personal. You should be able to modify your dotfiles, and save them in version control in your fork.
-
-However, the thoughtbot folks are often tweaking these dotfiles and you want to be able to get those updates.
+You should be able to experiment with your own dotfiles, save them in version
+control, and still get updates from `thoughtbot/dotfiles`.
-So, your master branch is meant for your customizations and use the `upstream` branch to get thoughtbot's updates.
+The `master` branch is for your customizations and the `upstream` branch is for
+thoughtbot's updates.
Set up the upstream branch
--------------------------
@@ -37,22 +44,37 @@ You only have to do this once:
git fetch upstream
git checkout -b upstream upstream/master
-Update thoughtbot's changes into your customizations
-----------------------------------------------------
+Make your own customizations
+----------------------------
+
+Put your customizations at the top of files, separated by "DO NOT EDIT BELOW
+THIS LINE."
+
+For example, the top of your `~/.gitconfig` might look like this:
-You will want to customize your environment. We suggest making changes in files that are not in thoughtbot's files.
+ [user]
+ name = Joe Ferris
+ email = jferris@thoughtbot.com
-For example, to customize your `zsh` config, make your changes in `~/.zshenv`:
+ # DO NOT EDIT BELOW THIS LINE
+
+ [push]
+ default = current
+
+The top of your `~/.zlogin` might look like this:
# RVM
[[ -s '/Users/croaky/.rvm/scripts/rvm' ]] && source '/Users/croaky/.rvm/scripts/rvm'
+ # DO NOT EDIT BELOW THIS LINE
+
# recommended by brew doctor
export PATH="/usr/local/bin:/usr/local/sbin:$PATH"
-Commit those kinds of things in your master branch.
+Get thoughtbot's updates
+------------------------
-Then, each time you want to update thoughtbot's changes.
+Each time you want to include thoughtbot's changes:
git checkout upstream
git pull
@@ -62,15 +84,12 @@ Then, each time you want to update thoughtbot's changes.
Credits
-------
-![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
-
-dotfiles are maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
+Thank you, [contributors](/thoughtbot/dotfiles/graphs/contributors)!
-Thank you to all [the contributors](https://github.com/thoughtbot/dotfiles/contributors)!
+![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+Dotfiles is maintained by [thoughtbot, inc](http://thoughtbot.com/community)
The names and logos for thoughtbot are trademarks of thoughtbot, inc.
-License
--------
-
-dotfiles is Copyright © 2009-2012 thoughtbot, inc.. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Dotfiles is © 2009-2012 thoughtbot, inc. It is free software and may be
+redistributed under the terms specified in the MIT-LICENSE file.
Please sign in to comment.
Something went wrong with that request. Please try again.