Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Improve README

Say the same thing with fewer words.
  • Loading branch information...
commit dbf37453a1a6109b738331479e432b4c91be2155 1 parent 4208970
@croaky croaky authored
Showing with 16 additions and 16 deletions.
  1. +16 −16 README.md
View
32 README.md
@@ -4,43 +4,43 @@ thoughtbot dotfiles
Install
-------
-First, [fork this repo](https://github.com/thoughtbot/dotfiles/fork_select) on Github.
+[Fork this repo](https://github.com/thoughtbot/dotfiles/fork_select) on Github.
-Then, clone your Github fork (replace "your-github-name" with your Github name) onto your laptop and install it:
+Clone your fork (replace `your-github-name` with your Github name).
git clone git@github.com:your-github-name/dotfiles.git
cd dotfiles
+
+Run the installer.
+
./install.sh
-This will create symlinks for all config files in your home directory. You can
-safely run this file multiple times to update.
+It creates symlinks for all dotfiles in your home directory. You can safely run
+this file multiple times to update.
-There is configuration for `zsh` so switch your shell from the default `bash` to `zsh` on OS X:
+Included are `zsh` dotfiles. To switch your shell to `zsh` on OS X:
chsh -s /bin/zsh
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.
+Your master branch is meant for your customizations. Use the `upstream` branch
+to get thoughtbot's updates.
-Set up the upstream branch
---------------------------
+Set up upstream
+---------------
-You only have to do this once:
+Do this once:
git remote add upstream git@github.com:thoughtbot/dotfiles.git
git fetch upstream
git checkout -b upstream upstream/master
-Update thoughtbot's changes into your customizations
-----------------------------------------------------
+Update upstream
+---------------
-You will want to customize your environment. We suggest making changes in files that are not in thoughtbot's files.
+Make changes in files that are not in thoughtbot's dotfiles.
For example, to customize your `zsh` config, make your changes in `~/.zshenv`:
Please sign in to comment.
Something went wrong with that request. Please try again.