From 1f7913f0c472b206f5c75e18066b62e5604c6d43 Mon Sep 17 00:00:00 2001 From: InsanusMokrassar Date: Sun, 28 Feb 2021 01:31:46 +0600 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 80943c7..294446d 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,22 @@ This application was created to decrease routine in process of project creating. * Include different developers with their nicknames and e-mails * Create configuration file with extension `kpsb` to be able to reconfigure publication in future via this app and simply update after new versions of application will be created +## Launch + +`java -jar artifact.jar` + +Instead of `artifact.jar` place name of loaded file. Currently in [releases](https://github.com/InsanusMokrassar/KotlinPublicationScriptsBuilder/releases) section there are eachcommit versions at least for linux x64. You may pass path to configuration. In this case launching will looks like `java -jar artifact.jar "path/to/config.kpsb"` + +## Building + +`./gradlew clean build` + +In case you wish to launch: `./gradlew run`. You may pass your configuration name with `./gradlew run --args="path/to/config.kpsb"`. Besides, you may create jar for your OS with `./gradlew packageUberJarForCurrentOS`, but with high probability you will require at least JDK 14 for this operation. + +## Output + +As an output you will get ready to use `publish.gradle` file with content like in [my other project (link to github file)](https://github.com/InsanusMokrassar/MicroUtils/blob/master/publish.gradle). + ## Screenshots ![Clear state](https://github.com/InsanusMokrassar/KotlinPublicationScriptsBuilder/blob/master/.github/images/Screenshot%20clear.png)