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

Improving documentation? #2

Open
Flajt opened this issue Mar 29, 2022 · 2 comments
Open

Improving documentation? #2

Flajt opened this issue Mar 29, 2022 · 2 comments

Comments

@Flajt
Copy link

Flajt commented Mar 29, 2022

Hello, first of all, thank you for the package.

I would like to ask if it's possible to provide some more information on how to set this package up and customize it.
I've managed to get it working after copying some stuff from the .grandle files under the example/android folder and updating my JDK, but I have no clue what changes are required and what not.

Also, it would be interesting to know how we can overwrite the service name and the logo, which (from my limited knowledge) has been set in the AndroidMainifest.xml of the package. I've read that you can sometimes overwrite the AndroidManifest of a library here but if I try to set my service tag with a different name, it now shows two options in the service selection menu (one is my service name and the other is the default one). Unfortunately, my native development knowledge is rather sparse, so I currently don't know how to solve that.

@luckyrat
Copy link
Member

Hi,

I've just added some usage guidance to the README and have also just added some additional customisation options and demonstrated their use in the updated example app.

I'm not an expert in Android native app development yet either so can't provide exact details on which changes are required in the gradle files (if any). It's possible that no changes to the standard Flutter template gradle files are required but I can't be certain.

You need to use tools/replace in the manifest to overwrite specific properties - I've now demonstrated that in the example app.

Hopefully that is enough to get you started but please let me know how you get on and if any specific questions remain.

I'm happy to add (or accept PRs with) additional documentation specific to getting this package working but don't want to duplicate general Android native development documentation. Hopefully the repo is now in a state that more closely reaches that correct balance!

@Flajt
Copy link
Author

Flajt commented Mar 30, 2022

This seems to look good so far, thanks a lot.
I will try to get something up and running in the next weeks/months and will document it. So I can create a pull request for some step-by-step instructions for the README.md and maybe some docstrings for the flutter code. It might take a while, bc I'm currently quite busy (maybe around May or so I should be free again), but I will definitely do it.

EDIT: Just wanted to say that I still have that in the back of my mind and it's not forgotten

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants