Skip to content

Commit f86452b

Browse files
RatakondalaArunMarkOSullivan94
authored andcommitted
docs(windows): added windows docs
1 parent 3f30632 commit f86452b

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ flutter_icons:
2626
image_path: "path/to/image.png"
2727
background_color: "#hexcode"
2828
theme_color: "#hexcode"
29+
windows:
30+
generate: true
31+
image_path: "path/to/image.png"
32+
icon_size: 48 # min:48, max:256, default: 48
2933
```
3034
3135
If you name your configuration file something other than `flutter_launcher_icons.yaml` or `pubspec.yaml` you will need to specify
@@ -73,6 +77,11 @@ Shown below is the full list of attributes which you can specify within your Flu
7377
- `background_color`: Updates *background_color* in `web/manifest.json`
7478
- `theme_color`: Updates *theme_color* in `web/manifest.json`
7579

80+
- `windows`: Add Windows related configs
81+
- `generate`: Specifies weather to generate icons for Windows platform or not
82+
- `image_path`: Path to web icon.png
83+
- `icon_size`: Windows app icon size. Icon size should be within this constrains *48<=icon_size<=256, defaults to 48*
84+
7685
*Note: iOS icons should [fill the entire image](https://stackoverflow.com/questions/26014461/black-border-on-my-ios-icon) and not contain transparent borders.*
7786

7887
The next two attributes are only used when generating Android launcher icon

0 commit comments

Comments
 (0)