diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..8ce98b2 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +Set up Cygwin +============= + +[](https://github.com/egor-tensin/setup-cygwin/actions?query=workflow%3ATest) + +This is a GitHub action that sets up Cygwin in your workflow run. + +1. Installs Cygwin. +2. Installs any additional packages specified. + +Use it in your workflow like this: + + - name: Set up Cygwin + uses: egor-tensin/setup-cygwin@v1 + with: + platform: x64 + packages: cmake python3 + +`x64` is the default value for the `platform` parameter and can be omitted. +Use `x86` if you want to install the 32-bit Cygwin. + +Specify any additional packages to be installed as a space-separated list in +the `packages` parameter. + +Set the installation directory using the `install-dir` parameter (C:\tools\cygwin +is the default). + +API +--- + +| Input | Value | Default | Description +| ----------- | ------- | ------- | ----------- +| platform | x64 | Yes | Install the 64-bit version. +| | *Other* | No | Install the 32-bit version. +| install-dir | *Empty* | Yes | Install to C:\tools\cygwin. +| | *Other* | No | Install to the specified directory. +| packages | *Empty* | Yes | Don't install any additional packages. +| | *Other* | No | Space-separated package names. + +The paths to the Cygwin binaries are added to the PATH variable. + +License +------- + +Distributed under the MIT License. +See [LICENSE.txt] for details. + +[LICENSE.txt]: LICENSE.txt |