Skip to content

Commit 2a7c3d3

Browse files
authored
Document that automake is installed by default, add example to README (#18)
1 parent d184ad9 commit 2a7c3d3

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ All of the following inputs are optional.
1616

1717
- `pkgs-to-install`:
1818
- Comma-separated list containing the Cygwin packages needed to install GAP
19-
- default: `'wget,git,gcc-g++,gcc-core,libgmp-devel,make,libtool,autoconf,zlib-devel,libreadline-devel,xdg-utils'`
19+
- default: `'wget,git,gcc-g++,gcc-core,libgmp-devel,make,libtool,autoconf,zlib-devel,libreadline-devel,xdg-utils,automake'`
2020
- `extra-pkgs-to-install`:
2121
- Comma-separated list containing the extra Cygwin packages needed to install additional packages
2222
- default: `''`
@@ -31,6 +31,29 @@ issue and possibly revert to v1).
3131
Moreover the `EXTRA_PKGS_TO_INSTALL` input was renamed to `extra-pkgs-to-install`,
3232
and `PKGS_TO_INSTALL` was renamed to `pkgs-to-install`.
3333

34+
### Examples
35+
36+
The following is a minimal example to run this action.
37+
38+
```yaml
39+
name: CI
40+
41+
on:
42+
push:
43+
pull_request:
44+
45+
jobs:
46+
# The CI test job
47+
test:
48+
name: CI test
49+
runs-on: windows-latest
50+
51+
steps:
52+
- uses: actions/checkout@v6
53+
- uses: gap-actions/setup-cygwin@v2
54+
# ... additional steps using GAP will usually follow here
55+
```
56+
3457
## Contact
3558
Please submit bug reports, suggestions for improvements and patches via
3659
the [issue tracker](https://github.com/gap-actions/setup-cygwin/issues).

0 commit comments

Comments
 (0)