Rewrite README + insightful gif

This commit is contained in:
Henrik Lissner 2016-11-09 13:38:26 +01:00
parent ab50a589bf
commit 1e03c7d7bd

View file

@ -1,28 +1,31 @@
# Henrik's dotfiles
[![MIT](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)
These are the dotfiles that fuel my madness, made for MacOS, Arch Linux and the various
debian-based boxes I frequently ssh into.
<img src="http://i.giphy.com/ZHlGzvZb130nm.gif" align="right" />
## Getting started
These are my dotfiles. They fuel my madness. Designed for MacOS, Arch Linux and the
various debian-based boxes I frequently ssh into.
`./bootstrap` does everything, including install packages and symlink dotfiles. Pass it
the modules you want. e.g.
My dotfiles are organized into "topics". The `./boostrap` script is used to install or
update them.
`./bootstrap install os/arch vcs/* shell/zsh`
+ `bootstrap install [topic1 topic2 ...]`: symlinks topics to `./.enabled.d` and
dotfiles therein to $HOME (then runs $topic/install)
+ `bootstrap update`: updates (enabled) topics that have a $topic/update script
+ `bootstrap clean`: deletes dead symlinks in $HOME
+ Each command has a one-letter shortcut: `./bootstrap i os/macos`
To update all modules:
Or use one of my recipes:
`./bootstrap update`
+ `bootstrap install recipes/ganymede` (my laptop)
Or to clear out all your symlinked dotfilse:
A few good-to-knows (where $topic is an enabled topic):
`./bootstrap clean`
Each command has a one-letter shortcut, e.g. `./bootstrap i os/macos`
+ zshrc auto-sources `$topic/*.zsh`
+ `$topic/bin` is added to PATH
+ `$topic/.*` (starts with a dot) is symlinked to $HOME
## Relevant
+ [Hammerspoon config](https://github.com/hlissner/.hammerspoon)
+ [Vim config](https://github.com/hlissner/.vim)
+ [Emacs config](https://github.com/hlissner/.emacs.d)