diff --git a/README.md b/README.md index 37e88a5..b513ca0 100644 --- a/README.md +++ b/README.md @@ -91,10 +91,9 @@ vaultik snapshot create vaultik snapshot list ``` -The default config is written for macOS. It backs up your home directory and -`/Applications`, with a list of excludes. A configured path that does not exist -stops the backup, unless you give `--skip-errors`. On another system, run -`vaultik config edit` first and change the `snapshots` section. +The default config backs up your home directory, with a list of excludes. On +macOS it also backs up `/Applications`. A configured path that does not exist +stops the backup, unless you give `--skip-errors`. 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 @@ -770,7 +769,7 @@ Prints these: - the version - the commit -- the commit date, labelled `build date` +- the commit date - the Go version - the platform - the author @@ -1318,6 +1317,8 @@ Two documents give the rules for work on this repository: - Go 1.26.1 or later. - Docker, with a daemon you can reach. `make test` and `make lint` run inside it. +- Node and yarn, for [prettier](https://prettier.io/), which formats the + Markdown. `script/bootstrap` installs them when the machine has none. ### Workflow @@ -1337,7 +1338,8 @@ standard. The scripts in `script/` are the entrypoints. Most `Makefile` targets call them. - `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/install-precommit`. - `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. - `script/lint-fix`: applies the linter's automatic fixes to your files. It needs a local Docker daemon. Run `script/lint` afterwards. -- `script/fmt`: formats the Go code. -- `script/fmt-check`: checks the formatting and changes nothing. +- `script/fmt`: formats the Go code and the Markdown. The Markdown is formatted + with prettier. +- `script/fmt-check`: checks the formatting of both and changes nothing. - `script/check`: runs these three scripts: - `script/test` - `script/lint`