diff options
| author | Mathias Bynens <mathias@qiwi.be> | 2012-01-23 22:52:15 +0100 |
|---|---|---|
| committer | Mathias Bynens <mathias@qiwi.be> | 2012-01-23 22:52:15 +0100 |
| commit | c6d420b9aa7da026ef053b080ccfaf617322c972 (patch) | |
| tree | a63b2675f9c4711726a9795a2f729181ad19fa89 /README.md | |
| parent | be0af1efaa67271d15a9e7364c0cd6f3700526f1 (diff) | |
| download | dotfiles-c6d420b9aa7da026ef053b080ccfaf617322c972.tar.gz dotfiles-c6d420b9aa7da026ef053b080ccfaf617322c972.tar.bz2 dotfiles-c6d420b9aa7da026ef053b080ccfaf617322c972.zip | |
README: Clarify that it doesn’t matter where the repository is cloned, and document ~/.extra
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -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: |