Repository files navigation

Your dotfiles are how you personalize your system. These are mine.

I was a little tired of having long alias files and everything strewn about(which is extremely common on other dotfiles projects, too). That led to thisproject being much more topic-centric. I realized I could split a lot of thingsup into the main areas I used (Ruby, git, system libraries, and so on), so Istructured the project accordingly.

If you're interested in the philosophy behind why projects like these areawesome, you might want toread my post on thesubject.

Everything's built around topic areas. If you're adding a new area to yourforked dotfiles — say, "Java" — you can simply add ajava directory and putfiles in there. Anything with an extension of.zsh will get automaticallyincluded into your shell. Anything with an extension of.symlink will getsymlinked without extension into$HOME when you runscript/bootstrap.

A lot of stuff. Seriously, a lot of stuff. Check them out in the file browserabove and see what components may mesh up with you.Fork it, remove what you don'tuse, and build on what you do use.

There's a few special files in the hierarchy.

• bin/: Anything inbin/ will get added to your$PATH and be madeavailable everywhere.
• topic/*.zsh: Any files ending in.zsh get loaded into yourenvironment.
• topic/path.zsh: Any file namedpath.zsh is loaded first and isexpected to setup$PATH or similar.
• topic/completion.zsh: Any file namedcompletion.zsh is loadedlast and is expected to setup autocomplete.
• topic/install.sh: Any file namedinstall.sh is executed when you runscript/install. To avoid being loaded automatically, its extension is.sh, not.zsh.
• topic/*.symlink: Any file ending in*.symlink gets symlinked intoyour$HOME. This is so you can keep all of those versioned in your dotfilesbut still keep those autoloaded files in your home directory. These getsymlinked in when you runscript/bootstrap.

Run this:

git clone https://github.com/holman/dotfiles.git~/.dotfilescd~/.dotfilesscript/bootstrap

This will symlink the appropriate files in.dotfiles to your home directory.Everything is configured and tweaked within~/.dotfiles.

The main file you'll want to change right off the bat iszsh/zshrc.symlink,which sets up a few paths that'll be different on your particular machine.

dot is a simple script that installs some dependencies, sets sane macOSdefaults, and so on. Tweak this script, and occasionally rundot fromtime to time to keep your environment fresh and up-to-date. You can findthis script inbin/.

I want this to work for everyone; that means when you clone it down it shouldwork for you even though you may not haverbenv installed, for example. Thatsaid, I do use this asmy dotfiles, so there's a good chance I may breaksomething if I forget to make a check for a dependency.

If you're brand-new to the project and run into any blockers, pleaseopen an issue on this repositoryand I'd love to get it fixed for you!

I forkedRyan Bates' excellentdotfiles for a couple years before theweight of my changes and tweaks inspired me to finally roll my own. But Ryan'sdotfiles were an easy way to get into bash customization, and then to jump shipto zsh a bit later. A decent amount of the code in these dotfiles stem or areinspired from Ryan's original project.