From c6d420b9aa7da026ef053b080ccfaf617322c972 Mon Sep 17 00:00:00 2001 From: Mathias Bynens Date: Mon, 23 Jan 2012 22:52:15 +0100 Subject: =?UTF-8?q?README:=20Clarify=20that=20it=20doesn=E2=80=99t=20matte?= =?UTF-8?q?r=20where=20the=20repository=20is=20cloned,=20and=20document=20?= =?UTF-8?q?~/.extra?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 074f65b..7576a18 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ ### Using Git and the bootstrap script +You can clone the repository wherever you want. (I like to keep it in `~/Projects/dotfiles`, with `~/dotfiles` as a symlink.) The bootstrapper script will pull in the latest version and copy the files to your home folder. + ```bash git clone https://github.com/mathiasbynens/dotfiles.git && cd dotfiles && ./bootstrap.sh ``` @@ -30,6 +32,19 @@ cd; curl -#L https://github.com/mathiasbynens/dotfiles/tarball/master | tar -xzv To update later on, just run that command again. +### Add custom commands without creating a new fork + +If `~/.extra` exists, it will be sourced along with the other files. You can use this to add a few custom commands without the need to fork this entire repository, or to add commands you don’t want to commit to a public repository. + +My `~/.extra` looks something like this: + +```bash +GIT_AUTHOR_NAME="Mathias Bynens" +GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME" +GIT_AUTHOR_EMAIL="mathias@mailinator.com" +GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL" +``` + ### Sensible OS X defaults When setting up a new Mac, you may want to set some sensible OS X defaults: -- cgit v1.2.3