diff --git a/libraries/tools/kotlin-stdlib-gen/ReadMe.md b/libraries/tools/kotlin-stdlib-gen/ReadMe.md new file mode 100644 index 00000000000..29e4552e806 --- /dev/null +++ b/libraries/tools/kotlin-stdlib-gen/ReadMe.md @@ -0,0 +1,11 @@ +## Code Generation for Standard Library + +Some of the code in the standard library is created by code generation based on templates. +For example, many Array methods need to be implemented separately for Array, ByteArray, ShortArray, IntArray, etc. + +To run the code generator from a kotlin checkout + + cd libraries/tools/kotlin-stdlib-gen + mvn compile exec:java + +This then runs the [GenerateStandardLib.kt](https://github.com/JetBrains/kotlin/blob/master/libraries/tools/kotlin-stdlib-gen/src/generators/GenerateStandardLib.kt) script to create the source from the files for java.lang.Iterable and java.util.Collection etc.