Skip to content

Commit 8db214c

Browse files
committed
update README
* add table of contents * add sections: outputs, environment variables
1 parent f63c37e commit 8db214c

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,22 @@
44

55
Action to setup a Fortran compiler.
66

7+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
8+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
9+
10+
- [Usage](#usage)
11+
- [Options](#options)
12+
- [Outputs](#outputs)
13+
- [Environment variables](#environment-variables)
14+
- [Runner compatibility](#runner-compatibility)
15+
- [License](#license)
16+
17+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
18+
719

820
## Usage
921

10-
This action allows setting up Fortran compilers on Ubuntu, MacOS and Windows runners.
22+
This action sets up a Fortran compiler on Ubuntu, MacOS and Windows runners.
1123

1224
```yaml
1325
jobs:
@@ -37,8 +49,28 @@ jobs:
3749
- *version*: Version of the compiler toolchain, available options for *gcc* are *5-12*
3850
3951
52+
## Outputs
53+
54+
The action sets the following outputs:
55+
56+
- `cc`: C compiler executable, e.g. `gcc`
57+
- `fc`: Fortran compiler executable, e.g. `gfortran`
58+
59+
60+
## Environment variables
61+
62+
The same values are also set as environment variables:
63+
64+
- `CC`
65+
- `FC`
66+
67+
These are made available to subsequent workflow steps via the [`GITHUB_ENV` environment file mechanism](https://docs.github.com/en/actions/learn-github-actions/environment-variables#passing-values-between-steps-and-jobs-in-a-workflow).
68+
69+
4070
## Runner compatibility
4171

72+
Support for the GCC toolchain varies across GitHub-hosted runner images.
73+
4274
<!-- compat starts -->
4375

4476
| | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 |

0 commit comments

Comments
 (0)