diff options
authorTom Ryder <tom@sanctum.geek.nz>2018-10-30 10:39:05 +1300
committerTom Ryder <tom@sanctum.geek.nz>2018-10-30 10:39:05 +1300
commitc3a8b8987d0361abd9b9cb11b94eece36466e9bf (patch)
parenta8c7c927dcf3c020389fd25c3e81e6c072a25dd1 (diff)
Documented the special install-conf target
2 files changed, 14 insertions, 1 deletions
diff --git a/ISSUES.md b/ISSUES.md
index 6d1ae3a4..282d8cdc 100644
--- a/ISSUES.md
+++ b/ISSUES.md
@@ -18,7 +18,6 @@ Known issues
* Would be good to complete the Makefile variables for NAME, EMAIL etc with
educated guesses (`id -u`@`cat /etc/mailname`) etc rather than hardcoding my
own stuff in there
-* Document `install-conf` target once I'm sure it's not a dumb idea
* Need to decide whether I care about XDG, and implement it if I do
* Need to decide whether I'm testing the shell snippets for MPD, Keychain etc,
and if so how.
diff --git a/README.md b/README.md
index 80f0cb1d..c9241cb8 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,20 @@ to figure out which shell's configuration files to install, falling back on
The remaining files can be installed with the other `install-*` targets. Try
`awk -f bin/mftl.awk Makefile` in the project's root directory to see a list.
+### Configuration
+To save a set of `make` targets useful for a specific user or host, you can
+save them in a newline-separated file `~/.dotfiles.conf`, and install using
+that with the special `install-conf` target. This can include variable
+settings, too:
+ $ cd
+ $ cat .dotfiles.conf
+ install-bash
+ install-bin
+ EMAIL=you@example.com
+ $ make -C .dotfiles install-conf