android-studio-poet icon indicating copy to clipboard operation
android-studio-poet copied to clipboard

Add docs

Open LouisCAD opened this issue 6 years ago • 1 comments

Hi, The example in the README is not sufficient for masses to start using this confidently. There's a documentation need to explain what you can do, how, in order to developers to start using it.

I see a great potential for this project as multi-module projects are becoming more and more common with multiple Android targets (Wear OS, TV, Auto Things...), Instant Apps and feature modules, Kotlin multiplatform, App bundle with optional app extension modules.

When I start a new project (like when starting an open source library with sample modules), configuring all the modules is the biggest burden, especially with countless gradle syncs needed as I need to add modules, and add dependencies. Android Studio Poet would probably help, but getting started is far from being straightforward, with not even a snippet I can copy, paste and edit, and the screenshot in the example is not even a working one.

If you want inspiration for examples, just make a config file that generates a project that includes all the Android Jetpack libraries, and an instant app 3 features project.

LouisCAD avatar May 18 '18 15:05 LouisCAD

Thanks Loius. We would like to understand better the points you raised:

  • We have snippets: SimpleConfig and FullConfig
  • How would you like to see the documentation, layout structure etc'
  • What can we do to make the documentation (and Andorid Studio Poet) more reachable and easy to use.
  • Pull requests welcome :)

borisf avatar May 18 '18 15:05 borisf