Skip to content

Commit

Permalink
Document how to match any version
Browse files Browse the repository at this point in the history
  • Loading branch information
jacebrowning committed Dec 7, 2019
1 parent a0900b7 commit 5594d59
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/cli/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Any of the following can be used as the `verchew` configuration filename:
* `verchew.ini`
* `.verchew`
* `.verchewrc`

# Version Arguments

If one of your system dependencies uses an argument other than `--version` to display its version information, this can be changed in the configuration file using the `cli_version_arg` setting:
Expand All @@ -25,7 +25,7 @@ If the program lacks a specific argument to display its version, but contains ve
[7-Zip]

cli = 7z
cli_version_arg =
cli_version_arg =
version = 16
```

Expand All @@ -40,6 +40,16 @@ cli = python
version = Python 2 || Python 3
```

# Any Version

If the version of a system dependency is not important to your project, leave out the `version` setting to simply check for the existence of that program:

```ini
[Hugo]

cli = hugo
```

# Optional Programs

If one of your system dependencies is optional and you only want to show a warning for incompatible versions, include the `optional` setting:
Expand Down

0 comments on commit 5594d59

Please sign in to comment.