From b12ce74be9f027597646f110662986564011ac40 Mon Sep 17 00:00:00 2001 From: Danielle McLean Date: Thu, 18 Jun 2020 13:47:48 +1000 Subject: [PATCH] Document the environment variables that can be set to customise dots --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index de836f1..4591bea 100644 --- a/README.md +++ b/README.md @@ -17,4 +17,16 @@ zsh dots When run through either of these methods, `dots` will install itself, [GNU Stow](https://www.gnu.org/software/stow/) (if not already installed globally), and my configuration for [git](https://git.00dani.me/dot/git), [vim](https://git.00dani.me/dot/vim), and [zsh](https://git.00dani.me/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. +By default, packages are installed by `dots` to `~/dotfiles` and then linked into `~` using Stow. Environment variables are available for customising this behaviour. + +## Environment Variables + +* `DOTFILES` - the location to clone new packages. Defaults to `~/dotfiles`. + Don't set it to `~`, because that'll just be super confusing. +* `DOTS_SOURCE_PREFIX` - a URL prefix that will be prepended to simple package + names, like "git" and "vim". Defaults to `https://git.00dani.me/dot`. You + might want to change this to point at your own Git hosting. +* `STOW` - which GNU Stow binary to use. Defaults to `stow`. You probably don't + need to change this. +* `HOME` - the target directory for linking packages. Probably not a good idea + to change this either.