Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[dist] README update

  • Loading branch information...
commit e7a4514bb5626dde68cea19402bcf01cd1ac00ce 1 parent c6d1bc0
Paolo Fragomeni authored
Showing with 69 additions and 8 deletions.
  1. +69 −8 README.md
View
77 README.md
@@ -1,17 +1,78 @@
# dotfiles
-## Synopsis
-A collection of convenient configuration files and scripts. Inspired and pilfered from many people.
+## Installation
-## Motivation
-Machine configuration is tedious. There are lots of subtle tweaks and system changes that reside in various places. The process for integrating these changes can be time consuming.
+### Using Git and the bootstrap script
-## Installation
-Don't use this repo `as-is`. These are personalized files, you should know and understand the scripts before you run them. Once you've done that,
-simply run the `bootstrap.sh` script and it will copy the files from the cloned repo into your `home` directory.
+You can clone the repository wherever you want. The bootstrapper script will pull in the latest version and copy the files to your home folder.
+
+```bash
+git clone https://github.com/hij1nx/dotfiles.git && cd dotfiles && ./bootstrap.sh
+```
+
+To update, `cd` into your local `dotfiles` repository and then:
+
+```bash
+./bootstrap.sh
+```
+
+Alternatively, to update while avoiding the confirmation prompt:
+
+```bash
+./bootstrap.sh -f
+```
+
+### Git-free install
+
+To install these dotfiles without Git:
+
+```bash
+cd; curl -#L https://github.com/hij1nx/dotfiles/tarball/master | tar -xzv --strip-components 1 --exclude={README.md,bootstrap.sh}
+```
+
+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
+# PATH additions
+export PATH="~/bin:$PATH"
+
+# Git credentials
+# Not in the repository, to prevent people from accidentally committing under my name
+GIT_AUTHOR_NAME="Paolo Fragomeni"
+GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
+git config --global user.name "$GIT_AUTHOR_NAME"
+GIT_AUTHOR_EMAIL="hij1nx@me.com"
+GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
+git config --global user.email "$GIT_AUTHOR_EMAIL"
+```
- ./bootstrap.sh
+### Sensible OS X defaults
+When setting up a new Mac, you may want to set some sensible OS X defaults:
+
+```bash
+./.osx
```
+
+## Feedback
+
+Suggestions/improvements
+[welcome](https://github.com/hij1nx/dotfiles/issues)!
+
+## This repo is composed of odds an ends from many people, many items are 2nd and 3rd hand, some known sources include...
+
+* [Gianni Chiappetta](http://gf3.ca/) for sharing his [amazing collection of dotfiles](https://github.com/gf3/dotfiles)
+* [Mathias Bynens](http://mathiasbynens.be/) for sharing his [amazing collection of dotfiles](https://github.com/mathiasbynens/dotfiles)
+* [Matijs Brinkhuis](http://hotfusion.nl/) and his [homedir repository](https://github.com/matijs/homedir)
+* [Jan Moesen](http://jan.moesen.nu/) and his [ancient `.bash_profile`](https://gist.github.com/1156154) + [shiny tilde repository](https://github.com/janmoesen/tilde)
+* [Ben Alman](http://benalman.com/) and his [dotfiles repository](https://github.com/cowboy/dotfiles)
+* [Tim Esselens](http://devel.datif.be/)
+* anyone who [contributed a patch](https://github.com/hij1nx/dotfiles/contributors) or [made a helpful suggestion](https://github.com/hij1nx/dotfiles/issues)
+
+
Please sign in to comment.
Something went wrong with that request. Please try again.