Skip to content

Commit 42f39c9

Browse files
authored
Update README to mention components other than ld (#11)
1 parent cfb1477 commit 42f39c9

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
# scala-native-cli
22

3-
Command Line Interface for the tools component of Scala Native. Tools handle the linking, optimisation and code generation phases.
4-
This means that the initial .scala files cannot be compiled with it - for that look to the nscplugin component.
3+
Command Line Interface for the various components of Scala Native.
54

6-
Please note that this api is meant for Scala Native power users. For a more friendly Scala Native building experience please use
5+
* scala-native-c compiles the Scala code to NIR (Native Intermediate Representation).
6+
* scala-native-ld links and optimises the NIR code to a binary file.
7+
* scala-native-p allows to view the compiled NIR code.
8+
9+
Please note that this api is meant for Scala Native power users. For a more friendly Scala Native building experience please consider using
710
the dedicated [sbt plugin](https://scala-native.readthedocs.io/en/stable/user/sbt.html#minimal-sbt-project) or [scala-cli](https://scala-cli.virtuslab.org).
811

912
## Usage
1013

11-
scala-native-cli --help will bring up possible options and syntax.
14+
`scala-native-ld --help` will bring up possible options and syntax.
1215
Since options are dependent on the used version of scala-native-cli, please use it for further instructions.
1316

14-
## Logging
17+
## Logging
1518

1619
For logging purposes, a default Scala Native logger is used. By default it will only show `Error` messages, but its verbosity can be increased with a -v flag.

0 commit comments

Comments
 (0)