Skip to content

Commit

Permalink
improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
bartekpacia committed Apr 1, 2024
1 parent 8897c3d commit b6150a9
Showing 1 changed file with 25 additions and 13 deletions.
38 changes: 25 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The following sections show how to configure this action.

## Specifying Flutter version

Use specific version and channel:
### Use specific version and channel

```yaml
steps:
Expand All @@ -21,8 +21,9 @@ steps:
- run: flutter --version
```

Use version from pubspec.yaml (inspired by
[`actions/setup-go`](https://github.com/actions/setup-go)):
### Use version from pubspec.yaml

This is inspired by [`actions/setup-go`](https://github.com/actions/setup-go).

```yaml
steps:
Expand All @@ -36,8 +37,10 @@ steps:
- run: flutter --version
```

> [!IMPORTANT] For `flutter-version-file` to work, you need to have the exact
> Flutter version defined in your pubspec.yaml:
> [!IMPORTANT]
>
> For `flutter-version-file` to work, you need to have the exact Flutter version
> defined in your pubspec.yaml:
>
> **Good**
>
Expand All @@ -56,6 +59,7 @@ steps:
> ```
> [!WARNING]
>
> Using `flutter-version-file` requires [`yq`][https://github.com/mikefarah/yq],
> which is not pre-installed in `windows` images. Install it yourself.
Expand All @@ -70,7 +74,7 @@ steps:
- run: flutter --version
```
Use latest release for particular version and/or channel:
### Use latest release for particular version and/or channel
```yaml
steps:
Expand All @@ -84,7 +88,7 @@ steps:
- run: flutter --version
```
Use particular version on any channel:
### Use particular version on any channel
```yaml
steps:
Expand All @@ -98,7 +102,7 @@ steps:
- run: flutter --version
```
Use particular git reference on master channel:
### Use particular git reference on master channel
```yaml
steps:
Expand Down Expand Up @@ -130,7 +134,11 @@ steps:
- run: flutter build appbundle
```
Build for **iOS** (macOS runners only):
### Build for iOS
> [!NOTE]
>
> Building for iOS requires a macOS runner.
```yaml
jobs:
Expand All @@ -148,7 +156,7 @@ jobs:
- run: flutter build ios --release --no-codesign
```
Build for the **web**:
### Build for the web
```yaml
steps:
Expand All @@ -163,7 +171,7 @@ steps:
- run: flutter build web
```
Build for **Windows**:
### Build for Windows
```yaml
jobs:
Expand All @@ -179,7 +187,7 @@ jobs:
- run: flutter build windows
```
Build for **Linux** desktop:
### Build for Linux desktop
```yaml
jobs:
Expand All @@ -198,7 +206,11 @@ jobs:
- run: flutter build linux
```
Build for **macOS** desktop:
### Build for macOS desktop
> [!NOTE]
>
> Building for macOS requires a macOS runner.
```yaml
jobs:
Expand Down

0 comments on commit b6150a9

Please sign in to comment.