git clone https://github.com/fs/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
sh script/setup
cd ~/.dotfiles
sh script/unlink
There's a few special files in the hierarchy.
bin/
: Anything inbin/
will get added to your$PATH
and be made available everywhere.topic/\*.bash
: Any files ending in.bash
get loaded into your environment.topic/path.bash
: Any file namedpath.bash
is loaded first and is expected to setup$PATH
or similar.topic/completion.bash
: Any file namedcompletion.bash
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 runscript/setup
.
Flatstack dotfiles is maintained by Timur Vafin. It was written by Zack Holman with the help of contributors.