diff --git a/README.md b/README.md index d3860696..eb9fa46c 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ within an Android App. The main functionality consists of fetching, updating and ## Integration -*build.gradle* +*build.gradle.kts* ``` implementation("org.eclipse.kuksa:kuksa-sdk:") ``` diff --git a/docs/QUICKSTART.md b/docs/QUICKSTART.md index ffbb0571..bf04816f 100644 --- a/docs/QUICKSTART.md +++ b/docs/QUICKSTART.md @@ -4,7 +4,7 @@ Get instantly bootstrapped into the world of the KUKSA SDK with the following co ## Integration -*build.gradle* +*build.gradle.kts* ``` implementation("org.eclipse.kuksa:kuksa-sdk:") ``` @@ -153,9 +153,26 @@ For a more convenient usage you can opt in to auto generate Kotlin models via [S of the same specification the Databroker uses. For starters you can retrieve an extensive default specification from the release page of the [COVESA Vehicle Signal Specification GitHub repository](https://github.com/COVESA/vehicle_signal_specification/releases). -*build.gradle* +*build.gradle.kts* ``` -ksp("org.eclipse.kuksa:vss-processor:") +plugins { + id("org.eclipse.kuksa.vss-processor-plugin") +} + +dependencies { + ksp("org.eclipse.kuksa:vss-processor:") +} + +// Copies the given specification file to the KSP processor +tasks.register("ProvideVssDefinition") { + val vssDefinitionFilePath = "$projectDir/src/main/assets/" + val regularFile = RegularFile { File(vssDefinitionFilePath) } + vssDefinitionFile.add(regularFile) +} + +tasks.withType { + dependsOn(tasks.withType()) +} ``` Use the new [`VssDefinition`](https://github.com/eclipse-kuksa/kuksa-android-sdk/blob/main/vss-core/src/main/java/org/eclipse/kuksa/vsscore/annotation/VssDefinition.kt) annotation and provide the path to the specification file (Inside the assets folder).