aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
blob: 6fdd268c435c8df9e1f77deb6df21adc195b20af (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
Set up MinGW-w64
================

[![Test](https://github.com/egor-tensin/setup-mingw/actions/workflows/test.yml/badge.svg)](https://github.com/egor-tensin/setup-mingw/actions/workflows/test.yml)

This GitHub action sets up MinGW-w64 in your workflow run.

Use it in your workflow like this:

    - name: Set up MinGW
      uses: egor-tensin/setup-mingw@v3
      with:
        platform: x64

* `x64` is the default value for the `platform` parameter and can be omitted.
Use `x86` if you want to build 32-bit binaries.
* `cc` and `c++` executables are set up, pointing to the `*-gcc` and `*-g++`
executables.
Disable this by setting the `cc` parameter to `0`.

API
---

| Input     | Value | Default | Description
| --------- | ----- | ------- | -----------
| platform  | x64   | ✓       | Install the x86_64 toolchain
|           | *any* |         | Install the i686 toolchain
| cc        | 1     | ✓       | Set up `cc`/`c++` executables
|           | *any* |         | Don't set up `cc`/`c++`
| version   |       | ✓       | Install the default (latest) version
|           | *any* |         | Install the specified version, if possible

| Output  | Example                  | Description
| ------- | ------------------------ | -----------
| prefix  | x86_64-w64-mingw32       | Cross-compilation toolchain prefix
| gcc     | x86_64-w64-mingw32-gcc   | `gcc` binary name
| gxx     | i686-w64-mingw32-g++     | `g++` binary name
| windres | i686-w64-mingw32-windres | `windres` binary name

License
-------

Distributed under the MIT License.
See [LICENSE.txt] for details.

[LICENSE.txt]: LICENSE.txt