From 517a1a26285954c4bddcd608d134f6df4314c285 Mon Sep 17 00:00:00 2001 From: John Mertz Date: Wed, 23 Feb 2022 20:57:45 -0500 Subject: [PATCH] Fix formatting, update paths --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a1c0a2da7..e8e93814c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# ${HOME}/.dotfiles +# `${HOME}/.dotfiles` Version control for dotfiles and templates. ## Purpose -${HOME}/.config and ${HOME} are a nightmare to version control. Maintaining a distinct dotfile directory then linking to those files is a much more sane way to cordon them off from the rest of the mess. +`${HOME}/.config` and `${HOME}` are a nightmare to version control. Maintaining a distinct dotfile directory then linking to those files is a much more sane way to cordon them off from the rest of the mess. ## Usage @@ -13,7 +13,7 @@ Make changes and maintain dotfiles in this directory. TODO: Everything below Define symlinks or dumper within the `.links` file. -Run `update_configs.pl` to refresh links and dump templates. +Run `${HOME}/scripts/update_configs.pl` to refresh links and dump templates. ## Details @@ -21,9 +21,9 @@ Run `update_configs.pl` to refresh links and dump templates. This file contains a JSON hash of the configuration files available with either a path to be linked, or the name of a dumper contained within [`${HOME}/scripts/dotfiles`](https://git.john.me.tz/jpm/scripts). -### ${HOME}/.state/linker.json +### `${HOME}/.spool/dotfiles.json` -This file contains a JSON hash of timestamps at which each configuration was last linked or dumped. The `update_configs.pl` script will use these times to know whether or not they need to be updated. It will do so if: +This file contains a JSON hash of timestamps at which each configuration was last linked or dumped. The `${HOME}/scripts/update_configs.pl` script will use these times to know whether or not they need to be updated. It will do so if: * it is a linked configuration file and the `.links` file has been updated since it was last linked. -* it is a dumpable template and the template has been updated since the last logged event. +* it is a dumpable template and the template has been updated since the last logged event. \ No newline at end of file