From e33cbbda4c50d72a31d69e36621444418774feda Mon Sep 17 00:00:00 2001 From: Ross Smith II Date: Sat, 1 May 2021 09:38:11 -0700 Subject: [PATCH] Update FAQ to consistently use ~/ --- _docs/110_faq.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/_docs/110_faq.md b/_docs/110_faq.md index 61ff70e..9e9ff11 100644 --- a/_docs/110_faq.md +++ b/_docs/110_faq.md @@ -105,7 +105,7 @@ Of course. You only need `gpg`, `openssl`, `transcrypt` or `git-crypt` installed if you plan on using the encrypt/decrypt features. yadm will tell you if it is missing a dependency for any command. -### Should I `yadm add` my `.config/yadm/encrypt` file? +### Should I `yadm add` my `~/.config/yadm/encrypt` file? Yes! This way your configuration for what files should be encrypted will follow you when you clone your repository. @@ -113,9 +113,9 @@ you when you clone your repository. ### Should I `yadm add` encrypted files to repository? No, you should not. Instead, add the names (or wildcard patterns) of the files you want -encrypted to `.config/yadm/encrypt`. Then, use the `yadm encrypt` command to encrypt the +encrypted to `~/.config/yadm/encrypt`. Then, use the `yadm encrypt` command to encrypt the matched files which then adds them to `~/.local/share/yadm/archive`. Then, use -`cd ; yadm add .local/share/yadm/archive` to add this file to the yadm repository. +`yadm add ~/.local/share/yadm/archive` to add this file to the yadm repository. This way, only encrypted versions of those files will be in the repository. After cloning or updating your repository, you can use `yadm decrypt` to extract the encrypted files from `~/.local/share/yadm/archive` into your working copy. See the @@ -123,7 +123,7 @@ encrypted files from `~/.local/share/yadm/archive` into your working copy. See t ### I modified an encrypted file, but yadm doesn't show any modifications. Why? -If you changed files which are matched by `.config/yadm/encrypt`, you must +If you changed files which are matched by `~/.config/yadm/encrypt`, you must re-run `yadm encrypt` to generate a new version of `~/.local/share/yadm/archive`. Then `~/.local/share/yadm/archive` can be added to a new commit.