Update/revise README

This commit is contained in:
Henrik Lissner 2017-09-02 19:01:00 +02:00
parent bd1d0e406c
commit f1706c6337
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395

View file

@ -1,19 +1,21 @@
[![MIT](https://img.shields.io/badge/license-MIT-green.svg?style=flat-square)](./LICENSE)
# Henrik's dotfiles # Henrik's dotfiles
[![MIT](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)
<img src="http://i.giphy.com/ZHlGzvZb130nm.gif" align="right" /> <img src="http://i.giphy.com/ZHlGzvZb130nm.gif" align="right" />
My dotfiles. Fuel for my madness. Designed for MacOS, Arch Linux and the various Fuel for my madness. Designed for Arch Linux, MacOS, and various remotes I
debian-based boxes I frequently ssh into. frequent.
It is organized into topics, some with their own READMEs. Check them out for more It is organized into topics, some with their own READMEs. Check them out for
targeted information. The `./boostrap` script is used to install and update them. more targeted information. The `./bootstrap` script is used to deploy and update
them.
## Bootstrap ## Bootstrap
`bootstrap` is my idempotent dotfile deployment script. `bootstrap` is my idempotent dotfile deployment script.
e.g. `./bootstrap os/arch shell/{zsh,tmux} dev/python` e.g. `./bootstrap os/+arch shell/+{zsh,tmux} dev/+pyenv`
``` ```
Usage: bootstrap [-iuldypLSU] [topic1[ topic2[ ...]]] Usage: bootstrap [-iuldypLSU] [topic1[ topic2[ ...]]]
@ -38,10 +40,11 @@ ln -sfv $topic/.* ~/
ln -sfv $topic/.{config,local}/* ~/.{config,local}/ ln -sfv $topic/.{config,local}/* ~/.{config,local}/
# 2. Track enabled topics in ~/.dotfiles/.enabled.d. # 2. Track enabled topics in ~/.dotfiles/.enabled.d.
# 3. If topic is enabled, run its update script. Otherwise, run its install script
if [[ -e ~/.dotfiles/.enabled.d/$topic ]]; then if [[ -e ~/.dotfiles/.enabled.d/$topic ]]; then
# 3a. If topic is already enabled, run update script
$topic/update $topic/update
else else
# 3b. Otherwise, run install script
ln -sfv $topic ~/.dotfiles/.enabled.d/ ln -sfv $topic ~/.dotfiles/.enabled.d/
$topic/install $topic/install
fi fi
@ -49,8 +52,8 @@ fi
## Clean ## Clean
`clean` will delete broken symlinks in `$HOME`, and can "disable" all topics by removing `clean` deletes broken symlinks in `$HOME`. If passed `-u`, it will remove all
their symlinks in `.enabled.d/`. symlinks in `.enabled.d/`, marking all topics as "disabled".
``` ```
Usage: clean [-du] Usage: clean [-du]