Forked from https://github.com/holman/dotfiles, borrows heavily from https://github.com/caarlos0/dotfiles
Your dotfiles are how you personalize your system. These are mine.
First, make sure you have all those things installed:
git
: to clone the repocurl
: to download some stufftar
: to extract downloaded stuffzsh
: to actually run the dotfilessudo
: some configs may need that
Then, run these steps:
$ git clone [email protected]:tylerwolf/dotfiles.git ~/.dotfiles
$ cd ~/.dotfiles
$ ./script/bootstrap
$ zsh # or just close and open your terminal again.
All changed files will be backed up with a
.backup
suffix.
You use it by running:
$DOTFILES/macos/set-defaults.sh
And logging out and in again/restart.
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
.
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 runscript/bootstrap
.