Skip to content

Commit 84aca99

Browse files
committed
Update README
1 parent 41a6598 commit 84aca99

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,40 @@ For an example of a workflow in action, see a run history
4141
for the [Swift Algorithms](https://github.com/skiptools/swift-algorithms) package at:
4242
[https://github.com/skiptools/swift-algorithms/actions](https://github.com/skiptools/swift-algorithms/actions)
4343

44+
## Configuration Options
4445

4546

47+
```
48+
swift-version:
49+
description: 'The version of the Swift toolchain to use'
50+
required: true
51+
default: '5.10.1'
52+
package-path:
53+
description: 'The folder where the swift package is checked out'
54+
required: true
55+
default: '.'
56+
swift-build-flags:
57+
description: 'Additional flags to pass to the swift build command'
58+
required: true
59+
default: ''
60+
android-emulator-options:
61+
description: 'Options to pass to the Android emulator'
62+
required: true
63+
default: '-no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim'
64+
android-emulator-boot-timeout:
65+
description: 'Emulator boot timeout in seconds'
66+
required: true
67+
default: 600
68+
run-tests:
69+
description: 'Whether to run the tests or just the build'
70+
required: true
71+
default: 'true'
72+
android-api-level:
73+
description: 'The API level of the Android emulator to run against'
74+
required: true
75+
default: 24
76+
```
77+
4678
## Releasing
4779

4880
To create a new release, make a new tag (like 1.0.0),

0 commit comments

Comments
 (0)