I forked this dotfiles to suit my own from Zach Holman's dotfiles. I used his dotfiles because its well documented and easy to modify.
I leave his documentation here for my future reference:
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/: Anything in
bin/
will get added to your$PATH
and be made available everywhere. - Brewfile: this is managed by homebrew-bundle. It manages:
- Homebrew (on macOS or Linux) for installing dependencies.
- Homebrew Cask for installing Mac applications.
- mas-cli for installing Mac App Store applications
- Whalebrew for installing Whalebrew images.
- Visual Studio Code for installing Visual Studio Code extensions.
- 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
.
Run this:
git clone https://github.com/firewalker06/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
script/bootstrap
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/zshrc.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 OS X
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/
.
This could happened if you are installing via drag-and-drop installation. To record it as a Cask app, run bundle install --force appname
to replace your current app with Cask.
Use brew bundle dump
to generate Brewfile
from currently things that homebrew-bundle manages. I recommend to use this occassionally to sync with currently installed apps.
Not promising to fix bugs, but if you found an issue, feel free to open an issue on this repository!