diff --git a/README.md b/README.md index bb118a1b..46f4a5e7 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,18 @@ I use Arch btw. The root of this repo is equivalent to my $HOME directory. -## Note on this repository +## This Repository -I use this repository to sync and backup my dotfiles. This is done automatically -on a timer. Therefore, these configs are: +I use this repository to sync and backup my dotfiles. I use the excellent [yadm] +to manage the repo, and [autoyadm](https://git.sr.ht/~ficd/autoyadm) to automate +committing & pushing on a timer. + +If you see a file with a weird name, like `config##hostname.dbox`, it's +leveraging `yadm`'s alternate files feature; the program will automatically +symlink that file to its appropriate destination depending on which computer +it's on. + +This is done automatically on a timer. Therefore, these configs are: - Always up-to-date. - Potentially broken on any given commit. @@ -22,15 +30,3 @@ keyboard) for navigation, depending on a few different factors. If `MNEI` conflicts with any defaults that would be far too finicky to remap, I just use the arrow keys. Otherwise, I bind `MNEI` to navigation. - -### Management - -Currently I'm using `yadm` to manage these dotfiles. I have tried some other -solutions like `chezmoi` and `stow`, but this one has stuck for me. I highly -recommend it. I use [AutoYADM](https://github.com/ficcdaf/autoyadm) to automate -committing and pushing my changes. - -If you see a file with a weird name, like `config##hostname.dbox`, it's -leveraging `yadm`'s alternate files feature; the program will automatically -symlink that file to its appropriate destination depending on which computer -it's on.