Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document on updating the application icon on core and wear apps #768

Open
renancaraujo opened this issue Aug 3, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers p2 Important issues not at the top of the work list

Comments

@renancaraujo
Copy link
Contributor

renancaraujo commented Aug 3, 2023

Extracted from #481

Description
As defined by #481 , people using our templates want to know how to update the application icons.

This card is about researching a step-by-step on how to perform this task, maybe using current tools such as Flutter laucher icons.

Then document the findings.

@renancaraujo renancaraujo added the bug Something isn't working as expected label Aug 3, 2023
@alestiago alestiago added good first issue Good for newcomers documentation Improvements or additions to documentation and removed bug Something isn't working as expected labels Aug 3, 2023
@BeatriceMitchell BeatriceMitchell moved this from Needs Triage to Backlog in VGV Open Source 🦄 🧙🌟 Aug 7, 2023
@Salonikansal2
Copy link

assign please

@Salonikansal2
Copy link

Here what i have tried to make it EASY to understand for a beginner .hope you like it @renancaraujo @alestiago

  1. Set Up the Configuration:
    Automatically generate a configuration file with this command:

flutter pub run flutter_launcher_icons:generate
This creates a flutter_launcher_icons.yaml file in your project's root directory.

If you want to specify a custom configuration file name, use:

flutter pub run flutter_launcher_icons:generate -f

To override an existing config file, use the -o flag:

flutter pub run flutter_launcher_icons:generate -o

Alternatively, you can add your Flutter Launcher Icons configuration to your pubspec.yaml file. Here's an example configuration:

dev_dependencies:
flutter_launcher_icons: "^0.13.1"

flutter_launcher_icons:
android: "launcher_icon"
ios: true
image_path: "assets/icon/icon.png"
min_sdk_android: 21
web:
generate: true
image_path: "path/to/image.png"
background_color: "#hexcode"
theme_color: "#hexcode"
windows:
generate: true
image_path: "path/to/image.png"
icon_size: 48
macos:
generate: true
image_path: "path/to/image.png"

  1. Run the Package:

After configuring, run the package with these commands:

flutter pub get
flutter pub run flutter_launcher_icons

If you used a custom configuration file name, specify it like this:

flutter pub get
flutter pub run flutter_launcher_icons -f
Ensure your config file is located in the same directory as pubspec.yaml.

Attributes:

You can customize various attributes in the configuration file, such as the image path and specific settings for Android, iOS, web, Windows, and macOS platforms.
Flavor Support:

If you have flavor support, create a configuration file for your flavor following the same format as the main configuration.

Troubleshooting:

If you encounter issues like color differences or image size problems, follow the troubleshooting guidance provided in the documentation
.
Be aware of potential compatibility issues with dependencies and resolve them accordingly.

@alestiago alestiago moved this from Backlog to Community in VGV Open Source 🦄 🧙🌟 Oct 29, 2023
@alestiago
Copy link
Contributor

@Salonikansal2 thanks for adding the information, would you mind opening a Pull Request with the change so the team can review it?

@Salonikansal2 Salonikansal2 removed their assignment Nov 17, 2023
@BeatriceMitchell BeatriceMitchell moved this from Community to Backlog in VGV Open Source 🦄 🧙🌟 Nov 27, 2023
@tomarra tomarra added the p2 Important issues not at the top of the work list label Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers p2 Important issues not at the top of the work list
Projects
Status: Backlog
Development

No branches or pull requests

4 participants