Forked from https://github.com/holman/dotfiles, but now steering in the direction of yadm
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 this project being much more topic-centric. I realized I could split a lot of things up into the main areas I used (Ruby, git, system libraries, and so on), so I structured the project accordingly.
If you're interested in the philosophy behind why projects like these are awesome, you might want to read my post on the subject.
The supported shell for these dotfiles is Zsh. Consider reading the guide if you are unfamiliar with it.
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
.
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.
There's a few special files in the hierarchy.
bin/
will get added to your $PATH
and be made
available everywhere..zshenv
)
path.zsh
file is loaded first and
is expected to setup $PATH
or similar.env.zsh
file is loaded
second and is expected to setup any additional environment
(e.g., shell options)..zshrc
)
fpath.zsh
file is loaded for
interactive shells only. They are expected to populate
$fpath
..zsh
(except those
specified elsewhere) are loaded for interactive shells only.
Interactive configuration can include aliases, color output,
prompt configuration, or anything else that should only be
loaded when a user is interacting with Zsh.completion.zsh
file is
loaded last for interactive shells only. They are expected
to setup autocomplete..zprofile
, .zlogin
, .zlogout
)
profile.zsh
file is loaded for
login shells only. Unlike .zlogin
, these files are loaded
before the interactive files above are loaded.login.zsh
file is loaded for login
shells only. Unlike .zprofile
, they are loaded after your
interactive files are loaded above. This is the ideal place
to put anything you want to see when you start up a new login
shell (e.g., cowsay, date, todo, fortune).logout.zsh
file is loaded for
login shells only and only when you exit/logout the shell.install.sh
is executed when you
run script/install
. To avoid being loaded automatically, its
extension is .sh
, not .zsh
.*.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
.Run this:
git clone https://github.com/holman/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
./script/bootstrap
./script/install
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/zshenv.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 macOS
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/
.
Because you don't want to necessarily ruin your local environment everytime you make a change, let's use Docker.
Note: you can only test the pieces of your dotfiles that will work in a Linux environment. macOS specifics cannot be tested.
Be sure Docker is installed.
brew cask install docker
./test/run.sh
I want this to work for everyone; that means when you clone it down it should
work for you even though you may not have rbenv
installed, for example. 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!
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.