diff --git a/README.md b/README.md index cf6bbfbc..581f3d51 100644 --- a/README.md +++ b/README.md @@ -39,16 +39,18 @@ Additionally, [awesome-openx](https://github.com/b-schwab/awesome-openx#datasets ## :rocket: Usage In order to use r:trån you need JDK 11 or later. -Download the executable jar at the [releases section](https://github.com/tum-gis/rtron/releases) and let it run: +Download the prebuilt JAR executable from the [releases section](https://github.com/tum-gis/rtron/releases/latest) and make sure that you have at least a JVM 11. +Run r:trån to ... + ```bash -# for transforming OpenDRIVE datasets to CityGML -java -jar rtron.jar opendrive-to-citygml ./input-opendrive-datasets ./output-citygml-datasets +# … validate OpenDRIVE datasets +java -jar rtron.jar validate-opendrive ./input-opendrive ./output-reports -# for validating OpenDRIVE datasets -java -jar rtron.jar validate-opendrive ./input-opendrive-datasets ./output-validation-reports +# … transform OpenDRIVE datasets to CityGML +java -jar rtron.jar opendrive-to-citygml ./input-opendrive ./output-citygml ``` -r:trån can [recursively](https://rtron.io/wiki/configuration) iterate over OpenDRIVE datasets contained in the input directory. +R:trån recursively iterates over your OpenDRIVE input datasets and creates the same directory structure for the output folder. ## :construction_worker: Building @@ -101,7 +103,7 @@ r:trån is distributed under the Apache License 2.0. See [LICENSE](LICENSE) for ## :handshake: Thanks -* [AUDI AG](https://github.com/audi) for providing an awesome work environment within [SAVe:](https://save-in.digital) -* Prof. [Thomas H. Kolbe](https://www.lrg.tum.de/en/gis/our-team/staff/prof-thomas-h-kolbe/), [Bruno Willenborg](https://www.lrg.tum.de/en/gis/our-team/staff/bruno-willenborg/) and [Christof Beil](https://www.lrg.tum.de/en/gis/our-team/staff/christof-beil/) for support and feedback -* [Claus Nagel](https://github.com/clausnagel) for [citygml4j](https://github.com/citygml4j/citygml4j) -* [JetBrains](https://github.com/JetBrains) for Kotlin and their top-notch IDEs +- [Lutz Morich](https://www.linkedin.com/in/lutz-morich-in/) and [AUDI AG](https://github.com/audi) for providing an awesome work environment within *SAVe* +- Prof. [Thomas H. Kolbe](https://www.asg.ed.tum.de/en/gis/our-team/staff/prof-thomas-h-kolbe/), [Bruno Willenborg](https://www.asg.ed.tum.de/en/gis/our-team/staff/bruno-willenborg/) and [Christof Beil](https://www.asg.ed.tum.de/en/gis/our-team/staff/christof-beil/) for support and feedback +- [Claus Nagel](https://github.com/clausnagel) for [citygml4j](https://github.com/citygml4j/citygml4j) +- [JetBrains](https://github.com/JetBrains) for Kotlin and their top-notch IDEs diff --git a/build.gradle.kts b/build.gradle.kts index ad007394..5bca2743 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -191,31 +191,12 @@ compileTestKotlin.kotlinOptions { } fun configureDokka() { - // if (COMMON_JVM_ONLY) return - subprojects { plugins.apply("org.jetbrains.dokka") - - /*val dokkaPlugin by configurations - dependencies { - dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.20") - }*/ } - // val dokkaOutputDir = "../versions" tasks.withType { - /*val mapOf = mapOf( - "org.jetbrains.dokka.versioning.VersioningPlugin" to - """{ "version": "${Project.version}", "olderVersionsDir":"$dokkaOutputDir" }""" - ) - - outputDirectory.set(file(projectDir.toPath().resolve(dokkaOutputDir).resolve(Project.version))) - pluginsMapConfiguration.set(mapOf)*/ } - - /*rootProject.plugins.withType { - rootProject.the().ignoreScripts = false - }*/ } configureDokka() diff --git a/buildSrc/src/main/kotlin/Configuration.kt b/buildSrc/src/main/kotlin/Configuration.kt index 15cbb6bc..e6514ec1 100644 --- a/buildSrc/src/main/kotlin/Configuration.kt +++ b/buildSrc/src/main/kotlin/Configuration.kt @@ -17,7 +17,7 @@ object Project { const val name = "rtron" const val group = "io.rtron" - const val version = "1.2.2" + const val version = "1.3-SNAPSHOT" } object ProjectComponents { diff --git a/buildSrc/src/main/kotlin/Dependencies.kt b/buildSrc/src/main/kotlin/Dependencies.kt index 51234966..28f919b4 100644 --- a/buildSrc/src/main/kotlin/Dependencies.kt +++ b/buildSrc/src/main/kotlin/Dependencies.kt @@ -30,9 +30,6 @@ object DependencyVersions { const val kotlinLogging = "3.0.3" const val slf4jSimple = "2.0.3" - // documentation libraries - //const val orchid = "0.21.1" - // object creation libraries const val kotlinxSerializationJson = "1.4.1" const val kaml = "0.49.0" diff --git a/rtron-cli/build.gradle.kts b/rtron-cli/build.gradle.kts index ae9e52ad..7a122dd8 100644 --- a/rtron-cli/build.gradle.kts +++ b/rtron-cli/build.gradle.kts @@ -39,5 +39,6 @@ application { tasks { named("shadowJar") { mergeServiceFiles() + archiveFileName.set("${Project.name}-${Project.version}.${this.archiveExtension.get()}") } } diff --git a/rtron-cli/src/main/kotlin/io/rtron/cli/Main.kt b/rtron-cli/src/main/kotlin/io/rtron/cli/Main.kt index 99c392f1..739f96d7 100644 --- a/rtron-cli/src/main/kotlin/io/rtron/cli/Main.kt +++ b/rtron-cli/src/main/kotlin/io/rtron/cli/Main.kt @@ -32,6 +32,6 @@ class MainCommand : CliktCommand(name = "rtron") { * @param args arguments of the cli */ fun main(args: Array) = MainCommand() - .versionOption("1.2.2") + .versionOption("1.3-SNAPSHOT") .subcommands(SubcommandValidateOpendrive(), SubcommandOpendriveToCitygml()) .main(args)