configs/scatterd-dotfiles
1
0
Fork 0
Code Issues 2 Pull requests 1 Projects Releases Packages Wiki Activity Actions

Working hard to make the README instructions extremely clear for newcomers and workshop students.

Browse source
This commit is contained in:
Dan Croak 2011-12-04 18:22:58 -05:00
parent 6458ae7015
commit 326ceb44e4
1 changed files with 18 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -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?
---------
One time:
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
--------------------------
You only have to do this once:
git remote add upstream git@github.com:thoughtbot/dotfiles.git
git fetch upstream