Skip to content

Commit 1e4abbc

Browse files
committed
doc cosmetics
1 parent 89ecb4b commit 1e4abbc

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -316,12 +316,7 @@ com.github.holgerbrandl:kscript-annotations:1.1
316316
Text Processing Mode
317317
--------------------
318318

319-
`kscript` can be used as a speedier and more flexible substitute for built-in terminal tools such as `awk` or `sed`
320-
321-
322-
`kscript` is complemented by
323-
324-
The text processing mode can be enabled with `-t` or `--text`. If so, `kscript` will
319+
`kscript` can be used as a speedier and more flexible substitute for built-in terminal text tools such as `awk` or `sed`. Its text processing mode can be enabled with `-t` or `--text`. If so, `kscript` will
325320

326321
* Declare `com.github.holgerbrandl:kscript-support:1.2.4` as dependency for the script. This [support library](https://github.com/holgerbrandl/kscript-support-api) eases the writing of Kotlin scriptlets for text-processing. It includes solutions to common use-cases like argument parsing, data streaming, IO utilities, and various iterators to streamline the writing of scriptlets for text processing.
327322
* Import the `kscript.*` namespace
@@ -347,7 +342,7 @@ Treat yourself a REPL with `--interactive`
347342

348343
To create an interactive kotlin shell (aka [REPL](https://kotlinlang.org/docs/tutorials/command-line.html#running-the-repl)) with all script dependencies added to the classpath you can use `--interactive`.
349344

350-
For example, let's assume the following short script, named `count_records.kts`
345+
For example, let's assume the following short script, named `CountRecords.kts`
351346
```kotlin
352347
#!/usr/bin/env kscript
353348
@file:DependsOn("de.mpicbg.scicomp:kutils:0.4")
@@ -366,11 +361,11 @@ println(records.count())
366361
To build a REPL that has the declared artifact in its classpath, we can just do
367362

368363
```bash
369-
kscript --interactive count_records.kts
364+
kscript --interactive CountRecords.kts
370365
```
371366
which will bring up the classpath-enhanced REPL:
372367
```
373-
Creating REPL from count_records.kts
368+
Creating REPL from CountRecords.kts
374369
Welcome to Kotlin version 1.1.51 (JRE 1.8.0_151-b12)
375370
>>> import de.mpicbg.scicomp.bioinfo.openFasta
376371
>>>
@@ -385,6 +380,7 @@ Artifacts and versions will differ between scripts, so it is hard to maintain th
385380
kscript --idea CountRecords.kts
386381
```
387382
This will open [IntelliJ IDEA](https://www.jetbrains.com/idea/) with a minimalistic project containing just your (1) `<script>` and (2) a generated `gradle.build` file:
383+
388384
![](misc/readme_images/minus_idea.png)
389385

390386

0 commit comments

Comments
 (0)