Skip to content

Commit

Permalink
docs(macos): added macos attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
RatakondalaArun authored and MarkOSullivan94 committed Aug 27, 2022
1 parent 03f22fc commit af2c6a9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ flutter_icons:
generate: true
image_path: "path/to/image.png"
icon_size: 48 # min:48, max:256, default: 48
macos:
generate: true
image_path: "path/to/image.png"
```
If you name your configuration file something other than `flutter_launcher_icons.yaml` or `pubspec.yaml` you will need to specify
Expand Down Expand Up @@ -86,6 +89,10 @@ Shown below is the full list of attributes which you can specify within your Flu
- `generate`: Specifies weather to generate icons for Windows platform or not
- `image_path`: Path to web icon.png
- `icon_size`: Windows app icon size. Icon size should be within this constrains *48<=icon_size<=256, defaults to 48*

- `macos`: Add MacOS related configs
- `generate`: Specifies weather to generate icons for MacOS platform or not
- `image_path`: Path to macos icon.png file

*Note: iOS icons should [fill the entire image](https://stackoverflow.com/questions/26014461/black-border-on-my-ios-icon) and not contain transparent borders.*

Expand Down
7 changes: 5 additions & 2 deletions example/default_example/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,16 @@ flutter_icons:
remove_alpha_ios: true
web:
generate: true
image_path: "path/to/image.png"
image_path: "assets/images/icon-1024x1024.png"
background_color: "#hexcode"
theme_color: "#hexcode"
windows:
generate: true
image_path: "path/to/image.png"
image_path: "assets/images/icon-1024x1024.png"
icon_size: 48 # min:48, max:256, default: 48
macos:
generate: true
image_path: "assets/images/icon-1024x1024.png"

dev_dependencies:
flutter_test:
Expand Down

0 comments on commit af2c6a9

Please sign in to comment.