Fix formatting, update paths

This commit is contained in:
John Mertz 2022-02-23 20:57:45 -05:00
parent 186a53355d
commit 517a1a2628
1 changed files with 6 additions and 6 deletions

View File

@ -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.