Follows the structure from holman/dotfiles and trishume/dotfiles
See also a simpler version which I recomend as a more lightweight starting point.
There's a few special files in the hierarchy.
bin/
: Anything inbin/
will get added to your$PATH
and be made available everywhere.topic/*.zsh
: Any files ending in.zsh
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./deploy.sh
.topic.config/*.symlink
: Any files / folders under atopic.config
folder get symlinked into your$HOME/.config
.topic/*.env.zsh
: Any files ending inenv.zsh
get loaded first so that other config files can use these variables.topic/*.install.sh
: Any files namedinstall.sh
get run when the root./install.sh
is run. Used for installing dependencies. These files should handle whether you are on osx or linux and also respect the NO_ROOT env variable.
Run this:
git clone git@github.com:erees1/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
./install.sh
If you are on linux and don't have root access run the following instead
NO_ROOT=1 ./install.sh
Then run:
./deploy.sh
Install tmux plugins with ctrl+a I