Before you go into an one command install please double-check following items and customize accordingly
- .gitconfig
- Brewfile.
- .zshrc.d
- Topics. You might don't want install
yarn
for instance, then just delete yarn folder, you might want to add new topics, refer to holman/dotfiles
NOTE: DO NOT delete this folders: dotbot
, script
, functions
, .zshrc.d
. They are important for the proccess of installing dotFiles.
Run this:
git clone https://github.com/eduardomoroni/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
./install
First of all, this will run dotbot based on this configuration. This will symlink the appropriate files in .dotfiles
to your home directory. Everything is configured and tweaked within ~/.dotfiles
.
Customizations can be done by following zsh-quickstart-kit customizations or following components customization
The main folder you'll want to take a look at is ./zshrc.d, which sets up a few configuration that'll be different on your particular machine.
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. - Brewfile: This is a list of applications for Homebrew Cask to install. Might want to edit this file before running any initial setup.
- 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/install.sh: Any file named
install.sh
is executed when you runscript/install
. To avoid being loaded automatically, its extension is.sh
, not.zsh
. - topic/*.symlink: Any file ending in
*.symlink
gets 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
.
I forked Zach Holman' excellent
dotfiles then mixed-up with zsh-quickstart-kit and dotbot.
Inspired from Ryan Bates' original project.