Update build instructions in ReadMe to include gradle build step.

Also update links and overall readme structure.
This commit is contained in:
Ilya Gorbunov
2017-04-07 03:48:57 +03:00
parent f5647fb27f
commit 5aabcb6ea3
7 changed files with 96 additions and 79 deletions
@@ -6,11 +6,13 @@ and ensure that the public binary API wasn't changed in a way that make this cha
## How to run
Compile and run tests. `CasesPublicAPITest` verifies the tool itself,
and `RuntimePublicAPITest` dumps the public API of `kotlin-runtime` and `kotlin-stdlib` jars,
which must be built beforehand with maven.
and `RuntimePublicAPITest` dumps the public API of `kotlin-stdlib`,
`kotlin-stdlib-jre7/8` and `kotlin-reflect` jars,
which must be built beforehand with gradle. Use `clean assemble` tasks,
since the incremental compilation currently doesn't produce all the required output.
When substantial changes are made to the public API, it may be convenient to overwrite
the entire dump and compare changes later before commiting: pass `-Doverwrite.output=true`
the entire dump and compare changes later before committing: pass `-Doverwrite.output=true`
property to the test to do so.
Also you can use shared run configuration "Binary compatibility tests", which also