psi-jack/yadm
1
0
Fork 0
mirror of synced 2024-12-22 14:41:07 -05:00
Code Issues Releases Wiki Activity

Update FAQ to consistently use ~/

Browse source
This commit is contained in:
Ross Smith II 2021-05-01 09:38:11 -07:00 committed by GitHub
parent b08402569d
commit e33cbbda4c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
_docs/110_faq.md
View file

@ -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 if you plan on using the encrypt/decrypt features. yadm will tell you if it is
missing a dependency for any command. 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 Yes! This way your configuration for what files should be encrypted will follow
you when you clone your repository. you when you clone your repository.
@ -113,9 +113,9 @@ you when you clone your repository.
### Should I `yadm add` encrypted files to 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 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 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 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 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 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? ### 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`. 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. Then `~/.local/share/yadm/archive` can be added to a new commit.