From 302f7617398a57e51fb7b5fa19b77d40d65853d4 Mon Sep 17 00:00:00 2001 From: Ilya Chernikov Date: Tue, 18 Feb 2020 08:14:21 +0100 Subject: [PATCH] Proofread --- ReadMe.md | 4 ++-- jvm/basic/jvm-embeddable-host/EmbeddableCompiler.md | 2 +- jvm/basic/jvm-maven-deps/MavenDeps.md | 2 +- jvm/basic/jvm-simple-script/SimpleScript.md | 2 +- jvm/main-kts/MainKts.md | 6 +++--- jvm/simple-main-kts/SimpleMainKts.md | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/ReadMe.md b/ReadMe.md index 7bfe24a..b091233 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -1,7 +1,7 @@ # Kotlin scripting examples -This repository contains example projects and individual scripts, as well es links to the external examples +This repository contains example projects and individual scripts, as well as links to the external examples demonstrating Kotlin Scripting functionality and API usage. If you know good examples of the Kotlin scripting API usage, not mentioned here, please submit an issue or a pull @@ -9,7 +9,7 @@ request with the link and short description. ## Examples in this repository -The complete project could be compiled with gradle, as well as imported e.g. in IntelliJ IDEA. +The complete project could be compiled with Gradle, as well as imported e.g. in IntelliJ IDEA. The individual example projects are mostly independent and could be copied and reused independently, but build files should be adopted accordingly, mostly to supply required Kotlin version properties and setup inter-project dependencies diff --git a/jvm/basic/jvm-embeddable-host/EmbeddableCompiler.md b/jvm/basic/jvm-embeddable-host/EmbeddableCompiler.md index 930c4a8..8aabc69 100644 --- a/jvm/basic/jvm-embeddable-host/EmbeddableCompiler.md +++ b/jvm/basic/jvm-embeddable-host/EmbeddableCompiler.md @@ -1,7 +1,7 @@ # Kotlin Scripting Examples: Scripting Host with Kotlin Compiler Embeddable -This example demonstrates the that uses the same definition as in the +This example demonstrates the usage of the same definition as in the [Simple script definition example](../jvm-simple-script/SimpleScript.md) but uses the embeddable version of the Kotlin compiler. The necessity of using embeddable compiler may arise when the dependencies that are packed into the `kotlin-compiler` jar, could conflict with the dependencies used by the host. diff --git a/jvm/basic/jvm-maven-deps/MavenDeps.md b/jvm/basic/jvm-maven-deps/MavenDeps.md index cf4e215..297b82e 100644 --- a/jvm/basic/jvm-maven-deps/MavenDeps.md +++ b/jvm/basic/jvm-maven-deps/MavenDeps.md @@ -2,7 +2,7 @@ # Kotlin Scripting Examples: Script with Dynamic dependencies from Maven This example demonstrates the [script definition](script/) and appropriate [scripting host ](host/) that implements -support for dynamic dependencies from Maven repositories usage, so une can write a script: +support for dynamic dependencies from Maven repositories usage, so one can write a script: ```kotlin @file:DependsOn("junit:junit:4.11") org.junit.Assert.assertTrue(true) diff --git a/jvm/basic/jvm-simple-script/SimpleScript.md b/jvm/basic/jvm-simple-script/SimpleScript.md index 91fb25b..180189d 100644 --- a/jvm/basic/jvm-simple-script/SimpleScript.md +++ b/jvm/basic/jvm-simple-script/SimpleScript.md @@ -1,5 +1,5 @@ # Kotlin Scripting Examples: Simple Script Definition -This example demonstrates creation of the [simple script definition project](script/) and simple +This example demonstrates the creation of the [simple script definition project](script/) and simple [scripting host project](host/) that uses the definition. diff --git a/jvm/main-kts/MainKts.md b/jvm/main-kts/MainKts.md index 2b7048f..854ab4b 100644 --- a/jvm/main-kts/MainKts.md +++ b/jvm/main-kts/MainKts.md @@ -1,8 +1,8 @@ # Kotlin Scripting Examples: `kotlin-main-kts` usages -Scripts demonstrating the usage of the `kotlin-main-kts` script definition jar, distributied with the Kotlin compiler -and IntelliJ plugin. +Scripts demonstrating the usage of the `kotlin-main-kts` script definition jar, distributed with the Kotlin compiler +and the IntelliJ plugin. *See also [simplified implementation in this repository](../simple-main-kts/SimpleMainKts.md)* @@ -44,7 +44,7 @@ provided that the shebang line is added to the script and works in the given OS ### Caching -The compiled scripts are cashed to the directory defined by an environmen variable `KOTLIN_MAIN_KTS_COMPILED_SCRIPTS_CACHE_DIR` +The compiled scripts are cashed to the directory defined by an environment variable `KOTLIN_MAIN_KTS_COMPILED_SCRIPTS_CACHE_DIR` *(`$TEMP/main.kts.compiled.cache` by default)*, and if the script is not changed, the compiled one is executed from the cache. ### IntelliJ support diff --git a/jvm/simple-main-kts/SimpleMainKts.md b/jvm/simple-main-kts/SimpleMainKts.md index b0c6ed1..f7ed157 100644 --- a/jvm/simple-main-kts/SimpleMainKts.md +++ b/jvm/simple-main-kts/SimpleMainKts.md @@ -17,8 +17,8 @@ The script definition implementation demonstrates many aspects of the script def scripting API usage, in particular: - refinement of the compilation configuration with the parameters passed to the annotations - dynamic script dependencies resolved via ivy library -- import scripts with possibility of sharing instances (diamond-shaped import) -- compilation cache, where cached compiled script are saved as executable jars +- import scripts with the possibility of sharing instances (diamond-shaped import) +- compilation cache, where cached compiled scripts are saved as executable jars - discovery file configuration, that could be used with IntelliJ IDEA and command-line compiler and others.