Update README.md for the four fixes merged into next

`config init` writes the apps snapshot, which backs up /Applications,
only on macOS, so the advice to edit the snapshots section first on
another system goes. `version` now labels the commit date "commit date".
`script/fmt` formats the Markdown with prettier as well as the Go code,
`script/fmt-check` checks both, and `script/bootstrap` installs node and
yarn for prettier. No document said that `snapshot verify` or
`remote info` printed outside `internal/ui`, so nothing changes for that
fix.

Model: fable-5-1
This commit is contained in:
sneak authored and clawbot committed 2026-11-11 07:01:54 +00:00
1 parent 718c10da10
commit 6107f60e55
1 file changed
+11 -8
+11 -8
View File
@@ -91,10 +91,9 @@ vaultik snapshot create
vaultik snapshot list vaultik snapshot list
``` ```
The default config is written for macOS. It backs up your home directory and The default config backs up your home directory, with a list of excludes. On
`/Applications`, with a list of excludes. A configured path that does not exist macOS it also backs up `/Applications`. A configured path that does not exist
stops the backup, unless you give `--skip-errors`. On another system, run stops the backup, unless you give `--skip-errors`.
`vaultik config edit` first and change the `snapshots` section.
On macOS, grant your terminal app Full Disk Access before the first backup. The On macOS, grant your terminal app Full Disk Access before the first backup. The
setting is under System Settings, Privacy & Security, Full Disk Access. Without setting is under System Settings, Privacy & Security, Full Disk Access. Without
@@ -770,7 +769,7 @@ Prints these:
- the version - the version
- the commit - the commit
- the commit date, labelled `build date` - the commit date
- the Go version - the Go version
- the platform - the platform
- the author - the author
@@ -1318,6 +1317,8 @@ Two documents give the rules for work on this repository:
- Go 1.26.1 or later. - Go 1.26.1 or later.
- Docker, with a daemon you can reach. `make test` and `make lint` run inside - Docker, with a daemon you can reach. `make test` and `make lint` run inside
it. it.
- Node and yarn, for [prettier](https://prettier.io/), which formats the
Markdown. `script/bootstrap` installs them when the machine has none.
### Workflow ### Workflow
@@ -1337,7 +1338,8 @@ standard. The scripts in `script/` are the entrypoints. Most `Makefile` targets
call them. call them.
- `script/bootstrap`: installs what development needs. It installs Go from - `script/bootstrap`: installs what development needs. It installs Go from
`script/install-go` when the machine has none, and it fails without Docker. `script/install-go` when the machine has none, and node, yarn and prettier for
the Markdown. It fails without Docker.
- `script/setup`: prepares a fresh clone. It runs `script/bootstrap` and - `script/setup`: prepares a fresh clone. It runs `script/bootstrap` and
`script/install-precommit`. `script/install-precommit`.
- `script/test`: runs the whole test suite, by building the `test` stage of the - `script/test`: runs the whole test suite, by building the `test` stage of the
@@ -1346,8 +1348,9 @@ call them.
`Dockerfile`. The linter runs only inside Docker. `Dockerfile`. The linter runs only inside Docker.
- `script/lint-fix`: applies the linter's automatic fixes to your files. It - `script/lint-fix`: applies the linter's automatic fixes to your files. It
needs a local Docker daemon. Run `script/lint` afterwards. needs a local Docker daemon. Run `script/lint` afterwards.
- `script/fmt`: formats the Go code. - `script/fmt`: formats the Go code and the Markdown. The Markdown is formatted
- `script/fmt-check`: checks the formatting and changes nothing. with prettier.
- `script/fmt-check`: checks the formatting of both and changes nothing.
- `script/check`: runs these three scripts: - `script/check`: runs these three scripts:
- `script/test` - `script/test`
- `script/lint` - `script/lint`