Skip to content

filkry/dotfiles

 
 

Repository files navigation

thefil does dotfiles

This is very overwhelmingly a fork of holman does dotfiles.

dotfiles

I appreciated holman's topic-centric approach.

My main contribution (outside of customization) has been to add a very hacked set of conditionals that allow various topics to be installed or ignored based on their includion of an osx or arch substring. This allows me to use the same bootstrap program on different OSs.

install

Run this:

git clone https://github.com/thefil/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
script/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 is zsh/zshrc.symlink, which sets up a few paths that'll be different on your particular machine.

dot is a simple script that installs some OS-dependent dependencies, sets sane defaults, and so on. Tweak this script, and occasionally run dot from time to time to keep your environment fresh and up-to-date. You can find this script in bin/.

topical

Everything's built around topic areas. If you're adding a new area to your forked dotfiles — say, "Java" — you can simply add a java directory and put files in there. Anything with an extension of .zsh will get automatically included into your shell. Anything with an extension of .symlink will get symlinked without extension into $HOME when you run script/bootstrap.

Topic directories containing osx or arch will only be installed on OSX and Arch Linux, respectively.

what's inside

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

components

There's a few special files in the hierarchy.

  • bin/: Anything in bin/ will get added to your $PATH and be made available everywhere.
  • topic/*.zsh: Any files ending in .zsh get loaded into your environment.
  • topic/path.zsh: Any file named path.zsh is loaded first and is expected to setup $PATH or similar.
  • topic/completion.zsh: Any file named completion.zsh is loaded last and is expected to setup autocomplete.
  • topic/*.symlink: Any files ending in *.symlink get symlinked into your $HOME. This is so you can keep all of those versioned in your dotfiles but still keep those autoloaded files in your home directory. These get symlinked in when you run script/bootstrap.

thanks

Obviously thanks to Zach Holman, who had the distant insight to create a system that was [almost] exactly what I needed. I repeat his thanks here out of respect:

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

Releases

No releases published

Packages

No packages published

Languages

  • Shell 68.2%
  • Ruby 17.2%
  • Vim Script 10.3%
  • Haskell 4.3%