Skip to content

HTTPS clone URL

Subversion checkout URL

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