Skip to content

Commit c8c9ee7

Browse files
author
Holger Brandl
committed
added packaging docs
1 parent 4b5c327 commit c8c9ee7

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,25 @@ Taken all these features together, `kscript` provides an easy-to-use, very flexi
1919

2020

2121
---
22-
### [`kscript` presentation from KotlinConf2017!](https://holgerbrandl.github.io/kscript_kotlinconf_2017/kscript_kotlinconf.html)
22+
**[`kscript` presentation from KotlinConf2017!](https://holgerbrandl.github.io/kscript_kotlinconf_2017/kscript_kotlinconf.html)**
23+
2324
---
2425

26+
[TOC levels=2,2]: # " "
27+
28+
- [Installation](#installation)
29+
- [Script Input Modes](#script-input-modes)
30+
- [Script Configuration](#script-configuration)
31+
- [Text Processing Mode](#text-processing-mode)
32+
- [Treat yourself a REPL with `--interactive`](#treat-yourself-a-repl-with---interactive)
33+
- [Boostrap IDEA from a `kscript`let](#boostrap-idea-from-a-kscriptlet)
34+
- [Deploy scripts as standalone binaries](#deploy-scripts-as-standalone-binaries)
35+
- [FAQ](#faq)
36+
- [Support](#support)
37+
- [How to contribute?](#how-to-contribute)
38+
- [Acknowledgements](#acknowledgements)
39+
40+
2541
Installation
2642
------------
2743

@@ -387,6 +403,18 @@ This will open [IntelliJ IDEA](https://www.jetbrains.com/idea/) with a minimalis
387403

388404
This assumes that you have the Intellij IDEA command line launcher `idea` in your `PATH`. It can be created in IntelliJ under `Tools -> Create Command-line Launcher`
389405

406+
Deploy scripts as standalone binaries
407+
--------------------------------------
408+
409+
To deploy a script simply do
410+
411+
```bash
412+
kscript --package some_script.kts
413+
./some_script --arg u ments
414+
```
415+
416+
Just `java` is required to run these binaries.
417+
390418
FAQ
391419
---
392420

@@ -413,7 +441,7 @@ In order to use cygwin you need to use windows paths to provide your scripts. Yo
413441
kscript $(cygpath -w /cygdrive/z/some/path/my_script.kts)
414442
```
415443

416-
## What are performance and resource usage difference between scripting with kotlin and python?
444+
### What are performance and resource usage difference between scripting with kotlin and python?
417445

418446
Kotlin is a compiled language, so there is a compilation overhead when you run a script/application written in Kotlin for the first time.
419447

0 commit comments

Comments
 (0)