Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 91 lines (67 sloc) 3.83 kb
7356dbf @holman THESE DOTFILES ARE IMPRESSING YOU
holman authored
1 # holman does dotfiles
2
3 ## dotfiles
4
c4b41d4 @holman 80c
holman authored
5 Your dotfiles are how you personalize your system. These are mine. The very
9e270f2 @holman kill rvm
holman authored
6 prejudiced mix: OS X, zsh, Ruby, Rails, git, homebrew, rbenv, vim. If you
c4b41d4 @holman 80c
holman authored
7 match up along most of those lines, you may dig my dotfiles.
7356dbf @holman THESE DOTFILES ARE IMPRESSING YOU
holman authored
8
c4b41d4 @holman 80c
holman authored
9 I was a little tired of having long alias files and everything strewn about
10 (which is extremely common on other dotfiles projects, too). That led to this
11 project being much more topic-centric. I realized I could split a lot of things
12 up into the main areas I used (Ruby, git, system libraries, and so on), so I
13 structured the project accordingly.
7356dbf @holman THESE DOTFILES ARE IMPRESSING YOU
holman authored
14
c4b41d4 @holman 80c
holman authored
15 If you're interested in the philosophy behind why projects like these are
16 awesome, you might want to [read my post on the
17 subject](http://zachholman.com/2010/08/dotfiles-are-meant-to-be-forked/).
c7bfde8 @holman I'm so philosofically
holman authored
18
7356dbf @holman THESE DOTFILES ARE IMPRESSING YOU
holman authored
19 ## install
20
21 - `git clone git://github.com/holman/dotfiles ~/.dotfiles`
22 - `cd ~/.dotfiles`
23 - `rake install`
24
c4b41d4 @holman 80c
holman authored
25 The install rake task will symlink the appropriate files in `.dotfiles` to your
26 home directory. Everything is configured and tweaked within `~/.dotfiles`,
27 though.
7356dbf @holman THESE DOTFILES ARE IMPRESSING YOU
holman authored
28
c4b41d4 @holman 80c
holman authored
29 The main file you'll want to change right off the bat is `zsh/zshrc.symlink`,
30 which sets up a few paths that'll be different on your particular machine.
99710de @holman add superpowers to the readme
holman authored
31
32 ## topical
33
c4b41d4 @holman 80c
holman authored
34 Everything's built around topic areas. If you're adding a new area to your
35 forked dotfiles — say, "Java" — you can simply add a `java` directory and put
36 files in there. Anything with an extension of `.zsh` will get automatically
37 included into your shell. Anything with an extension of `.symlink` will get
38 symlinked without extension into `$HOME` when you run `rake install`.
99710de @holman add superpowers to the readme
holman authored
39
40 ## what's inside
2c5a391 @holman apply less suck to readme
holman authored
41
71ae9e5 @holman Update the README to be a bit more flexible
holman authored
42 A lot of stuff. Seriously, a lot of stuff. Check them out in the file browser
43 above and see what components may mesh up with you. Fork it, remove what you
44 don't use, and build on what you do use.
45
46 ## components
47
48 There's a few special files in the hierarchy.
49
848cfd2 @holman fix markdown rendering
holman authored
50 - **bin/**: Anything in `bin/` will get added to your `$PATH` and be made
71ae9e5 @holman Update the README to be a bit more flexible
holman authored
51 available everywhere.
52 - **topic/\*.zsh**: Any files ending in `.zsh` get loaded into your
53 environment.
54 - **topic/\*.symlink**: Any files ending in `*.symlink` get symlinked into
55 your `$HOME`. This is so you can keep all of those versioned in your dotfiles
56 but still keep those autoloaded files in your home directory. These get
57 symlinked in when you run `rake install`.
58 - **topic/\*.completion.sh**: Any files ending in `completion.sh` get loaded
59 last so that they get loaded after we set up zsh autocomplete functions.
60
61 ## add-ons
62
c4b41d4 @holman 80c
holman authored
63 There are a few things I use to make my life awesome. They're not a required
71ae9e5 @holman Update the README to be a bit more flexible
holman authored
64 dependency, but if you install them they'll make your life a bit more like a
65 bubble bath.
c11841b @holman grc is not a dependency anymore
holman authored
66
c4b41d4 @holman 80c
holman authored
67 - If you want some more colors for things like `ls`, install grc: `brew install
68 grc`.
9e270f2 @holman kill rvm
holman authored
69 - If you install the excellent [rbenv](https://github.com/sstephenson/rbenv) to
70 manage multiple rubies, your current branch will show up in the prompt. Bonus.
c11841b @holman grc is not a dependency anymore
holman authored
71
53112aa @holman bug notice
holman authored
72 ## bugs
73
74 I want this to work for everyone; that means when you clone it down it should
9e270f2 @holman kill rvm
holman authored
75 work for you even though you may not have `rbenv` installed, for example. That
53112aa @holman bug notice
holman authored
76 said, I do use this as *my* dotfiles, so there's a good chance I may break
77 something if I forget to make a check for a dependency.
78
79 If you're brand-new to the project and run into any blockers, please
80 [open an issue](https://github.com/holman/dotfiles/issues) on this repository
81 and I'd love to get it fixed for you!
82
7356dbf @holman THESE DOTFILES ARE IMPRESSING YOU
holman authored
83 ## thanks
84
c4b41d4 @holman 80c
holman authored
85 I forked [Ryan Bates](http://github.com/ryanb)' excellent
86 [dotfiles](http://github.com/ryanb/dotfiles) for a couple years before the
87 weight of my changes and tweaks inspired me to finally roll my own. But Ryan's
88 dotfiles were an easy way to get into bash customization, and then to jump ship
89 to zsh a bit later. A decent amount of the code in these dotfiles stem or are
90 inspired from Ryan's original project.
Something went wrong with that request. Please try again.