From 186a53355d091f0a746aa248c1b257a149bd8740 Mon Sep 17 00:00:00 2001 From: John Mertz Date: Wed, 23 Feb 2022 20:37:35 -0500 Subject: [PATCH] Aspirational first commit --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..a1c0a2da7 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# ${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. + +## Usage + +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. + +## Details + +### `.links` + +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 + +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: + +* 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.