Skip to content

Commit 3b90157

Browse files
committed
README: improve the description of the input parameters
For now, only `flavor`/`architecture` are documented. More to come. Signed-off-by: Johannes Schindelin <[email protected]>
1 parent 09dce7f commit 3b90157

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,15 @@ jobs:
2323
2424
### Available flavors
2525
26-
It supports several flavors:
26+
This Action supports several flavors (read: subsets) of the Git for Windows SDK that can be configured like this:
27+
28+
```yaml
29+
- uses: git-for-windows/setup-git-for-windows-sdk
30+
with:
31+
flavor: build-installers
32+
```
33+
34+
The supported flavors are:
2735
2836
- `minimal`:
2937

@@ -43,7 +51,16 @@ It supports several flavors:
4351

4452
### CPU architecture support
4553

46-
The Git for Windows SDK can be installed targeting `x86_64` (AKA "64-bit") and `i686` (AKA 32-bit).
54+
Git for Windows SDK comes in variants targeting `x86_64` (AKA "64-bit") and `i686` (AKA 32-bit). The default is `x86_64` and can be overridden like this:
55+
56+
```yaml
57+
- uses: git-for-windows/setup-git-for-windows-sdk
58+
with:
59+
flavor: build-installers
60+
architecture: i686
61+
```
62+
63+
Please note that only the `build-installers` and the `full` flavors are available for `i686`.
4764

4865
## Developing _this_ Action
4966

0 commit comments

Comments
 (0)