From ef010ce7b5956bd567a1f9e825e800c228647023 Mon Sep 17 00:00:00 2001 From: Roey Darwish Dror Date: Mon, 21 Jan 2019 20:17:44 +0200 Subject: [PATCH] Document the configuration path in Windows (fix #111) --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 75497482..b34922e3 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ Just run `topgrade`. It will run the following steps: * `--no-retry` - Don't ask to retry failed steps. ## Customization -You can place a configuration file at `~/.config/topgrade.toml` (on macOS `~/Library/Preferences/topgrade.toml`).. Here's an example: +Here's an example for a configuration file: ``` toml @@ -138,3 +138,11 @@ git_repos = [ will not proceed * `commands` - Custom upgrade steps. If any command fails it will be reported in the summary as all upgrade steps are reported, but it will not cause Topgrade to stop. + +### Configuration path + +The configuration should be placed in the following paths depending by the operating system: + +* **macOS** - `~/Library/Preferences/topgrade.toml` +* **Windows** - `%APPDATA%/topgrade.toml` +* **Other Unix systems** - `~/.config/topgrade.toml`