aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2020-05-12 22:49:01 +1200
committerTom Ryder <tom@sanctum.geek.nz>2020-05-12 22:49:01 +1200
commit0f9e22cb629b330dc3e8208b5b350722c3a7fb59 (patch)
tree8bb706c93412446ebfac9c7b1d047d881dca002e /README.md
parentSwitch Mutt to XDG basedirs (diff)
downloaddotfiles-0f9e22cb629b330dc3e8208b5b350722c3a7fb59.tar.gz
dotfiles-0f9e22cb629b330dc3e8208b5b350722c3a7fb59.zip
Reformat README and fix a path or two
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 14 insertions, 14 deletions
diff --git a/README.md b/README.md
index eb383653..a214c9ef 100644
--- a/README.md
+++ b/README.md
@@ -25,9 +25,9 @@ For the default `all` target, you'll need a POSIX-fearing userland, including
The installation `Makefile` overwrites things standing in the way of its
installed files without backing them up, so read the output of `make -n
-install` before running `make install` carefully, to make sure you aren't going to lose
-anything unexpected. If you're still not sure, install it in a temporary
-directory first, so you can explore:
+install` before running `make install` carefully, to make sure you aren't going
+to lose anything unexpected. If you're still not sure, install it in
+a temporary directory first, so you can explore:
$ tmpdir=$(mktemp -d)
$ make install HOME="$tmpdir"
@@ -47,9 +47,9 @@ dependencies:
* `install-readline`
* `install-vim`
-The `install-login-shell` target looks at your `SHELL` environment variable, and tries
-to figure out which shell's configuration files to install, falling back on
-`install-sh`.
+The `install-login-shell` target looks at your `SHELL` environment variable,
+and tries to figure out which shell's configuration files to install, falling
+back on `install-sh`.
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.
@@ -57,12 +57,12 @@ The remaining files can be installed with the other `install-*` targets. Try
### Configuration
To keep a set of `make` targets useful for a specific user or host, you can
-list them in a newline-separated file `~/.local/share/dotfiles.conf`, and
-install using that with the special `install-conf` target. This can include
-variable settings, too:
+list them in a newline-separated file `~/.config/dotfiles/config`, and install
+using that with the special `install-conf` target. This can include macro
+settings for the `Makefile`, too:
$ cd
- $ cat .local/share/dotfiles.conf
+ $ cat .config/dotfiles/config
install-bash
install-bin
EMAIL=you@example.com
@@ -264,8 +264,8 @@ off using a stub file installed in `~/.config/bash_completion`. The majority
of the time I just want to complete paths anyway, and this makes for a quicker
startup without a lot of junk functions in my Bash namespace.
-I do make some exceptions with completions defined in `.bash_completion.d`
-files, for things I really do get tired of typing repeatedly:
+I do make some exceptions with completions defined in files in
+`~/.bash_completion.d` for things I really do get tired of typing repeatedly:
* Bash builtins: commands, help topics, shell options, variables, etc.
* `find(1)`'s more portable options
@@ -299,8 +299,8 @@ colored cyan.
### Mutt
My mail is kept in individual Maildir-format directories under `~/mail`, with
-the system mail spool in e.g. `/var/mail/tejr` being where most unfiltered mail
-is sent. I use [Getmail](http://pyropus.ca/software/getmail/),
+the system mail spool in e.g. `/var/mail/tejr` being where most unfiltered new
+mail is spooled. I use [Getmail](http://pyropus.ca/software/getmail/),
[maildrop](https://www.courier-mta.org/maildrop/), and
[msmtp](https://marlam.de/msmtp/); the configurations for these are not
included here. I sign whenever I have some indication that the recipient might