Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 100 lines (68 sloc) 4.044 kb
7d02270 @mathiasbynens Initial commit.
authored
1 # Mathias’s dotfiles
2
43e8353 @mathiasbynens Add installation instructions.
authored
3 ## Installation
4
8c0c9aa @mathiasbynens README: Add Git-less installation instructions
authored
5 ### Using Git and the bootstrap script
ac5170b @mathiasbynens Add a note about the `.osx` file.
authored
6
c6d420b @mathiasbynens README: Clarify that it doesn’t matter where the repository is cloned, a...
authored
7 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.
8
ac5170b @mathiasbynens Add a note about the `.osx` file.
authored
9 ```bash
8c0c9aa @mathiasbynens README: Add Git-less installation instructions
authored
10 git clone https://github.com/mathiasbynens/dotfiles.git && cd dotfiles && ./bootstrap.sh
ac5170b @mathiasbynens Add a note about the `.osx` file.
authored
11 ```
12
13 To update, `cd` into your local `dotfiles` repository and then:
7e2ffe5 @mathiasbynens Add update instructions.
authored
14
15 ```bash
16 ./bootstrap.sh
17 ```
18
9850a48 @mathiasbynens README: Document the -f/--force option for bootstrap.sh
authored
19 Alternatively, to update while avoiding the confirmation prompt:
20
21 ```bash
22 ./bootstrap.sh -f
23 ```
24
8c0c9aa @mathiasbynens README: Add Git-less installation instructions
authored
25 ### Git-free install
26
27 To install these dotfiles without Git:
28
29 ```bash
f62dfea @mathiasbynens README: List files while untarring
authored
30 cd; curl -#L https://github.com/mathiasbynens/dotfiles/tarball/master | tar -xzv --strip-components 1 --exclude={README.md,bootstrap.sh}
8c0c9aa @mathiasbynens README: Add Git-less installation instructions
authored
31 ```
32
33 To update later on, just run that command again.
34
ab64db6 @mathiasbynens .bash_profile: Source `~/.path` before and `~/.extra` after all the othe...
authored
35 ### Specify the `$PATH`
36
f57f9e7 @mathiasbynens README: Add example `~/.path` file
authored
37 If `~/.path` exists, it will be sourced along with the other files, before any feature testing (such as [detecting which version of `ls` is being used](https://github.com/mathiasbynens/dotfiles/blob/aff769fd75225d8f2e481185a71d5e05b76002dc/.aliases#L21-26)) takes place.
38
0e28ec0 @mathiasbynens .bash_profile: Add `~/bin` to the `$PATH`
authored
39 Here’s an example `~/.path` file that adds `~/utils` to the `$PATH`:
f57f9e7 @mathiasbynens README: Add example `~/.path` file
authored
40
41 ```bash
0e28ec0 @mathiasbynens .bash_profile: Add `~/bin` to the `$PATH`
authored
42 export PATH="$HOME/utils:$PATH"
f57f9e7 @mathiasbynens README: Add example `~/.path` file
authored
43 ```
ab64db6 @mathiasbynens .bash_profile: Source `~/.path` before and `~/.extra` after all the othe...
authored
44
c6d420b @mathiasbynens README: Clarify that it doesn’t matter where the repository is cloned, a...
authored
45 ### Add custom commands without creating a new fork
46
47 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.
48
49 My `~/.extra` looks something like this:
50
51 ```bash
bb49a55 @mathiasbynens README: Tweak the part about ~/.extra
authored
52 # PATH additions
53 export PATH="~/bin:$PATH"
54
55 # Git credentials
56 # Not in the repository, to prevent people from accidentally committing under my name
c6d420b @mathiasbynens README: Clarify that it doesn’t matter where the repository is cloned, a...
authored
57 GIT_AUTHOR_NAME="Mathias Bynens"
58 GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
bb49a55 @mathiasbynens README: Tweak the part about ~/.extra
authored
59 git config --global user.name "$GIT_AUTHOR_NAME"
c6d420b @mathiasbynens README: Clarify that it doesn’t matter where the repository is cloned, a...
authored
60 GIT_AUTHOR_EMAIL="mathias@mailinator.com"
61 GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
bb49a55 @mathiasbynens README: Tweak the part about ~/.extra
authored
62 git config --global user.email "$GIT_AUTHOR_EMAIL"
c6d420b @mathiasbynens README: Clarify that it doesn’t matter where the repository is cloned, a...
authored
63 ```
64
ab64db6 @mathiasbynens .bash_profile: Source `~/.path` before and `~/.extra` after all the othe...
authored
65 You could also use `~/.extra` to override settings, functions and aliases from my dotfiles repository. It’s probably better to [fork this repository](https://github.com/mathiasbynens/dotfiles/fork_select) instead, though.
66
8c0c9aa @mathiasbynens README: Add Git-less installation instructions
authored
67 ### Sensible OS X defaults
68
69 When setting up a new Mac, you may want to set some sensible OS X defaults:
70
71 ```bash
72 ./.osx
73 ```
74
5325c97 @mathiasbynens README: Mention `.brew`
authored
75 ### Install Homebrew formulae
76
77 When setting up a new Mac, you may want to install some common Homebrew formulae (after installing Homebrew, of course):
78
79 ```bash
80 ./.brew
81 ```
82
8c0c9aa @mathiasbynens README: Add Git-less installation instructions
authored
83 ## Feedback
84
7d02270 @mathiasbynens Initial commit.
authored
85 Suggestions/improvements
86 [welcome](https://github.com/mathiasbynens/dotfiles/issues)!
87
88 ## Thanks to…
8c0c9aa @mathiasbynens README: Add Git-less installation instructions
authored
89
7d02270 @mathiasbynens Initial commit.
authored
90 * [Gianni Chiappetta](http://gf3.ca/) for sharing his [amazing collection of dotfiles](https://github.com/gf3/dotfiles)
46196ac @mathiasbynens README: Link to @matijs/dotfiles instead of @matijs/homedir
authored
91 * [Matijs Brinkhuis](http://hotfusion.nl/) and his [dotfiles repository](https://github.com/matijs/dotfiles)
65ba27d @mathiasbynens README: Credit Chris Gerke (@cgerke)
authored
92 * [Jan Moesen](http://jan.moesen.nu/) and his [ancient `.bash_profile`](https://gist.github.com/1156154) + [shiny _tilde_ repository](https://github.com/janmoesen/tilde)
779de13 @mathiasbynens Add a link to cowboy/dotfiles
authored
93 * [Ben Alman](http://benalman.com/) and his [dotfiles repository](https://github.com/cowboy/dotfiles)
9910901 @mathiasbynens README: Add @necolas and @tejr
authored
94 * [Nicolas Gallagher](http://nicolasgallagher.com/) and his [dotfiles repository](https://github.com/necolas/dotfiles)
95 * [Tom Ryder](http://blog.sanctum.geek.nz/) and his [dotfiles repository](https://github.com/tejr/dotfiles)
65ba27d @mathiasbynens README: Credit Chris Gerke (@cgerke)
authored
96 * [Chris Gerke](http://www.randomsquared.com/) and his [tutorial on creating an OS X SOE master image](http://chris-gerke.blogspot.com/2012/04/mac-osx-soe-master-image-day-7.html) + [_Insta_ repository](https://github.com/cgerke/Insta)
9a6037a @mathiasbynens README: Credit @ptb
authored
97 * @ptb and [his _OS X Lion Setup_ repository](https://github.com/ptb/Mac-OS-X-Lion-Setup)
48a45fd @mathiasbynens README: Credit Lauri
authored
98 * [Lauri ‘Lri’ Ranta](http://lri.me/) for sharing [loads of hidden preferences](http://lri.me/hiddenpreferences.txt)
29cadd5 @mathiasbynens Tweak README.
authored
99 * [Tim Esselens](http://devel.datif.be/)
79c9c3e @mathiasbynens Link to the issue tracker for suggestions.
authored
100 * anyone who [contributed a patch](https://github.com/mathiasbynens/dotfiles/contributors) or [made a helpful suggestion](https://github.com/mathiasbynens/dotfiles/issues)
Something went wrong with that request. Please try again.