From bc1748d5929321577a1223660412b708dadd0c5f Mon Sep 17 00:00:00 2001 From: Danielle McLean Date: Tue, 4 Oct 2016 12:46:40 +1100 Subject: [PATCH] Wrote a better README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 63a2d8f..73ebaed 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # dot-dots -A bootstrap for my dotfiles that also acts as a simple management script once installed. Bootstrapping is as simple as: +A fast and easy bootstrap for my dotfiles that also acts as a simple management script once installed. Bootstrapping is as simple as: - curl https://dots.00dani.id.au | zsh +```zsh +curl https://dots.00dani.id.au | zsh +``` + +`dots` will then install itself, [GNU Stow](https://www.gnu.org/software/stow/) (if not already installed globally), and my configuration for [git](https://github.com/00dani/dot-git), [vim](https://github.com/00dani/dot-vim), and [zsh](https://github.com/00dani/dot-zsh). + +Packages are installed by `dots` to `~/dotfiles` and then linked into `~` using Stow. I'll be adding flags for customising these paths, as well as adjusting which packages the bootstrap immediately installs.