diff options
| author | Egor Tensin <Egor.Tensin@gmail.com> | 2020-12-25 04:17:09 +0300 |
|---|---|---|
| committer | Egor Tensin <Egor.Tensin@gmail.com> | 2020-12-25 04:17:09 +0300 |
| commit | b5d2105754ca5a3851b40abdbec558e14f756e07 (patch) | |
| tree | 9dd194555a8f543f614184276835ecd07c5eaf23 | |
| parent | initial commit (diff) | |
| download | setup-gcc-b5d2105754ca5a3851b40abdbec558e14f756e07.tar.gz setup-gcc-b5d2105754ca5a3851b40abdbec558e14f756e07.zip | |
add README
| -rw-r--r-- | README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..b18e303 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +Set up GCC +========== + +[](https://github.com/egor-tensin/setup-gcc/actions?query=workflow%3ATest) + +This is a GitHub action that sets up GCC in your workflow run. + +1. Installs either 32-bit or 64-bit GCC on either Ubuntu or Cygwin. +2. For installing GCC on Windows please see my action [setup-mingw]. + +[setup-mingw]: https://github.com/egor-tensin/setup-mingw + +Use it in your workflow like this: + + - name: Set up GCC + uses: egor-tensin/setup-gcc@v1 + 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. +* Set the `cygwin` parameter to `1` to set up GCC inside an existing Cygwin +installation (you can set up Cygwin itself using my action [setup-cygwin]). + +[setup-cygwin]: https://github.com/egor-tensin/setup-cygwin + +API +--- + +| Input | Value | Default | Description +| -------- | ------- | ------- | ----------- +| platform | x64 | Yes | Install the x86_64 toolchain. +| | *Other* | No | Install the i686 toolchain. +| cygwin | 1 | No | Install Cygwin packages. +| | *Other* | Yes | Install native binaries. + +License +------- + +Distributed under the MIT License. +See [LICENSE.txt] for details. + +[LICENSE.txt]: LICENSE.txt |