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.
If you're interested in the philosophy behind why projects like these are awesome, you might want to read my post on the subject.
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
.
More about symbolic link can be found in here.
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. To make individual scripts work, run the scriptadd-bins
located in that same folder. First, give it execution permissions with the command$ sudo chmod +x add-bins
. After that, run the command with$ ./add-bins <BIN_NAME>
and pass the bin you want to make executable system-wide. You can also pass multiple bins separated by space at once. By doing this, the binary will be added as a "shim" in your rbenv directory, so you need to have rbenv installed before doing this. - Brewfile: This is a list of applications for Homebrew Cask to install: things like Chrome and 1Password and Adium and stuff. 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
.
Run this:
git clone https://github.com/lsfernandes92/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
script/install
The install script will grap all the topic/install.sh
files in this repo and
perform system updates. For linux for example it will update the apt-get
repo
and install basic packages, some developer libraries, databases, security and
privacy packages, most used apps and useful tools.
Note: if any .sh
file fails to run append the correct access permissions to
the file by giving it's execute permission. You can do that by typing the
command in your shell: $chmod -x <SH_SCRIPT_FILE>
Note2: The install script include the installation of zsh
, but to that take
effect and to make the zsh
your default shell take a look at
this
After that, run the following:
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/
.
Another way that to stay up-to-date is to run the alias command update!
that
is found here.
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!
I forked Ryan Bates' excellent dotfiles for a couple years before the weight of my changes and tweaks inspired me to finally roll my own. But Ryan's dotfiles were an easy way to get into bash customization, and then to jump ship to zsh a bit later. A decent amount of the code in these dotfiles stem or are inspired from Ryan's original project.