1# Building Kotlin Serialization from the source 2 3## JDK version 4 5To build Kotlin Serialization JDK version 11 or higher is required. Make sure this is your default JDK (`JAVA_HOME` is set accordingly). 6This is needed to compile the `module-info` file included for JPMS support. 7 8In case you are determined to use a different JDK version or experience problems with JPMS, you can turn off compilation of module-info files 9completely with `disableJPMS` property: add `disableJPMS=true` to gradle.properties or `-PdisableJPMS` to Gradle CLI invocation. 10 11## Runtime library 12 13Kotlin Serialization runtime library itself is a [multiplatform](http://kotlinlang.org/docs/reference/multiplatform.html) project. 14To build the library from the source and run all tests, use `./gradlew build`. Corresponding platform tasks like `jvmTest,` `jsTest,` `macosArm64Test`, and so on are also available. 15 16The project can be opened in IntelliJ IDEA without additional prerequisites. 17In case you want to work with Protobuf tests, you may need to run `./gradlew generateTestProto` beforehand. 18 19 20To install runtime library into the local Maven repository, run `./gradlew publishToMavenLocal`. 21After that, you can include this library in arbitrary projects like usual gradle dependency: 22 23```gradle 24repositories { 25 mavenLocal() 26} 27 28dependencies { 29 compile "org.jetbrains.kotlinx:kotlinx-serialization-core:$serialization_version" 30} 31``` 32 33To use snapshot version of compiler (if you have built and installed it from sources), use flag `-Pbootstrap`. 34If you have built both Kotlin and Kotlin/Native compilers, set `KONAN_LOCAL_DIST` environment property to the path with Kotlin/Native distribution 35(usually `kotlin-native/dist` folder inside Kotlin project). 36 37The `master` and `dev` branches of the library should be binary compatible with the latest released compiler plugin. In case you want to test some new features from other branches, 38which are still in development and may not be compatible in terms of bytecode produced by plugin, you'll need to build the plugin by yourself. 39 40## Compiler plugin 41 42Compiler plugins for Gradle/Maven and IntelliJ plugin, starting from Kotlin 1.3, are embedded into the Kotlin compiler. 43 44Sources and steps to build it are located [here](https://github.com/JetBrains/kotlin/tree/master/plugins/kotlinx-serialization). 45In short, you'll just need to run `./gradlew dist install` to get `2.x.255-SNAPSHOT` versions of Kotlin compiler, stdlib, and serialization plugins in the Maven local repository. 46