Skip to content

Latest commit

 

History

History
77 lines (59 loc) · 3.26 KB

README.md

File metadata and controls

77 lines (59 loc) · 3.26 KB
Raw

Alias does dotfiles

dotfiles

Your dotfiles are how you personalize your system. These are mine based on holman's dot files but more focused on bash. If you match up along most of those lines, you may dig my dotfiles.

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 this project being much more topic-centric. I realized I could split a lot of things up into the main areas I used (PHP, git, system libraries, and so on), so I structured the project accordingly.

Install

Run this:

git clone https://github.com/alias-mac/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, though.

The main file you'll want to change right off the bat is bash/bashrc.symlink, which sets up a few paths that'll be different on your particular machine. If you prefer you can use the ~/.localrc to override them per instance.

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 .bash 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.

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.
  • Brewfile: This is a list of packages and applications for Homebrew and Homebrew Cask to install: things like git, grc, wget or applications like Chrome and VSCode. Might want to edit this file before running any initial setup.
  • topic/*.bash: Any files ending in .bash get loaded into your environment.
  • 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.
  • topic/*.completion.bash: Any files ending in completion.bash get loaded last so that they get loaded after we set up all *.bash files (dependencies).

Bugs

I want this to work for everyone; that means when you clone it down it should work for you. That said, I do use this as my dotfiles, so there's a good chance I may break something if I forget to make a check for a dependency.

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

Thanks

I forked Zach Holman's excellent dotfiles for a some years before the weight of my changes and tweaks inspired me to finally roll my own. But Holman's dotfiles were an easy way to get into bash customization. A decent amount of the code in these dotfiles stem or are inspired from Holman's original project.