Skip to content

Commit 753842f

Browse files
committed
Update README
1 parent af479ec commit 753842f

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

README.md

+7-13
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ Useful when Gradle or the IDE let you down 💔
88
[@holgerbrandl](https://github.com/holgerbrandl) for KScript.
99

1010
The script has been tested on macOS 🍎, but it is completely untested on
11-
Linux 🐧 and Windows 🖥️.
11+
Linux 🐧 and Windows 🖥️. KScript may not work at all on Windows!
1212

13-
⚠️There may be [major issues](https://github.com/rock3r/deep-clean/issues/4) on Windows/Linux when using `-n`, please let me know if you encounter any such issue!
13+
⚠️There may be [major issues](https://github.com/rock3r/deep-clean/issues/4) on Windows/Linux when using `-n`,
14+
please let me know if you encounter any such issue!
1415

1516
**USE AT YOUR OWN RISK IN ANY CASE!**
1617

@@ -64,33 +65,26 @@ Where the options are:
6465
-v --verbose Print detailed information about all commands.
6566
```
6667

68+
For this script to work, you need to have `kotlin`, `kscript` and `maven` on your `PATH`.
6769
If you **DON'T have all three commands** on your `PATH`, then read on to the next
6870
section to install them.
6971

7072
## Installing the script dependencies
7173

7274
To make the script run, we'll first need to install all the required dependencies.
73-
All dependencies are available on [SDKMan!](https://sdkman.io/) (Windows, Linux, macOS)
74-
and on [Homebrew](https://brew.sh/) (macOS only).
75-
76-
**Windows, Linux:**
75+
All dependencies are available on [SDKMan!](https://sdkman.io/) (Windows, Linux, macOS).
76+
**Note that KScript support for Windows is not officially available yet**.
7777

7878
```bash
7979
$ sdk install kotlin
8080
$ sdk install maven
8181
$ sdk install kscript
8282
```
8383

84-
**macOS:**
85-
86-
```bash
87-
$ brew install kotlin maven holgerbrandl/tap/kscript
88-
```
89-
9084
## Licence
9185

9286
```
93-
Copyright 2021 Sebastiano Poggi
87+
Copyright 2022 Sebastiano Poggi
9488
9589
Licensed under the Apache License, Version 2.0 (the "License");
9690
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)