Add (minimum) requirements to readme or faq

[k3b]

• which min-sdk is required for the target-app to use the gradle-plugin?
• are there other requirements needed for the gradle-plugin to make it work?
• how much time is needed for somebody who never used the gradle-plugin to optimize the app?

[moraispgsi]

I will give you a brief answer and later if you would like I can go into further detail.

LeafactorCI as of now only deals with simple Java files. As far as I know, it can support Java version 1 to 11 through static analysis, this is due to the capabilities of Spoon. I haven't investigated in detail the limitation in terms of SDK versions due to time constraints(this is a necessary point, I am glad you brought that up) but after testing a couple of open-source projects I can tell you that it does not seem to be a concern. The Gradle version I would recommend to use the latest one, I have yet to compile a list of supported versions.

As of now, all the requirements that were found are listed in the FAQ section. An internet connection would be a requirement I suppose hehe.

Well, ideally LeafactorCI should be used in a continuous integration environment. If that is the case the person setting it up would need to have some understanding in that regard. As for the refactoring process, the changes are made to the files automatically, so a review should be done before merging any of the changes. This requires a basic understanding of the APP to see if something is wrong. The changes are rather simple, and mistakes will be probably captured by the compiler. For the basic usage, meaning that a person manually installs and runs it, it is about a 5 to 10 min installation and execution. The execution takes about a minute to run given that the project is already built.

[moraispgsi]

Forgot to say that contributions are welcome :D