Add a Building section to the README #407
Conversation
|
I would put it under |
It's actually already there (it's a h3 inside the h2 Contributing) |
library-no-op/build.gradle
Outdated
| @@ -15,6 +15,7 @@ android { | |||
| lintOptions { | |||
| warningsAsErrors true | |||
| abortOnError true | |||
| disable 'GradleDependency' | |||
There was a problem hiding this comment.
Why do we need this? To not show warnings about future Gradle versions, like we have now?
There was a problem hiding this comment.
Why do we need this?
We need this as currently lint is failing on master (as we don't run it on CI) because of this.
In my change I'm suggesting to run ./gradlew build in the readme, but that command will actually fail as of now.
Either we suppress GradleDependency globally or we have to comment every dependency in the .gradle file with //noinspect GradleDependency. I generally disable this Lint check and let Gradle (or the other tools like Dependabot) take care of the dependencies.
Anyway I'm amending this change as I'll take care of the lint failures in another PR
63369e0 to
62b9634
Compare
Co-authored-by: Volodymyr Buberenko <vbuberen@users.noreply.github.com>
📄 Context
This is related to #248, I'm adding a Building section to the README to clarify how to setup the local environment for developing the library.
📝 Changes
Buildingwith a mention on the ktlint pre-commit hookgradlew buildsuggested command in order to run all the tests locallyGradleDependencylint check asgradlew buildis failing on master due to obsolete OkHTTP dependency (that's intentional).