Skip to content

Commit

Permalink
Working hard to make the README instructions extremely clear for newc…
Browse files Browse the repository at this point in the history
…omers and workshop students.
  • Loading branch information
Dan Croak committed Dec 4, 2011
1 parent 6458ae7 commit 326ceb4
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,37 @@
thoughtbot dotfiles
===================

Flow:

* Fork this repo.
* Clone your fork.
* Install.
* Track thoughtbot/dotfiles.
* Customize in master.
* Update.

Install
-------

From your cloned directory:
First, [fork this repo](https://github.com/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:

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.

Note that there is configuration for `zsh` so if you'd like to switch your shell from the default `bash` to `zsh`, on OS X you do:
There is configuration for `zsh` so switch your shell from the default `bash` to `zsh` on OS X:

chsh -s /bin/zsh

Track thoughtbot/dotfiles
-------------------------
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.

So, your master branch is meant for your customizations and use the `upstream` branch to get thoughtbot's updates.

Set up the upstream branch
--------------------------

One time:
You only have to do this once:

git remote add upstream git@github.com:thoughtbot/dotfiles.git
git fetch upstream
Expand Down

0 comments on commit 326ceb4

Please sign in to comment.