admin/topgrade
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document the configuration path in Windows (fix #111)

Browse Source
This commit is contained in:
Roey Darwish Dror
2019-01-21 20:17:44 +02:00
parent 84323d9729
commit ef010ce7b5
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -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`