git clone https://github.com/mathieudutour/dotfiles.git ~/.dotfiles && cd ~/.dotfiles && script/bootstrap
Your dotfiles are how you personalize your system. These are mine.
I was a little tired of having long alias files and everything strewn about (which is extremely common on other dotfiles projects, too). That led to this project being much more topic-centric. I realized I could split a lot of things up into the main areas I used (Ruby, git, system libraries, and so on), so I structured the project accordingly.
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/
will get added to your $PATH
and be made.zsh
get loaded into yourpath.zsh
is loaded first and is$PATH
or similar.completion.zsh
is loadedinstall.sh
is executed when you run script/install
. To avoid being loaded automatically, its extension is .sh
, not .zsh
.*.symlink
gets symlinked into$HOME
. This is so you can keep all of those versioned in your dotfiles$HOME
,+
signs to signify additional directory delimiters.topic/config+topic.symlink
would get$HOME/.config/topic
when you run script/bootstrap
.Run this:
git clone https://github.com/mathieudutour/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 macOS
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/
.
You might want to install Jetbrains Mono, a great monospace font.
I want this to work for everyone; that means when you clone it down it should
work for you even though you may not have rbenv
installed, for example. That
said, I do use this as my dotfiles, so there's a good chance I may break
something if I forget to make a check for a dependency.
If you're brand-new to the project and run into any blockers, please open an issue on this repository and I'd love to get it fixed for you!