azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme to fix grammar, spelling, wording (#1058)

Browse Source 
I have updated the Readme markdown file to fix certain grammar and spelling issues.
This commit is contained in:
Tristan Greeno
2017-11-21 03:04:40 -06:00
committed by Nikolay Igotti
parent 783a18fad2
commit 2aa18d5833
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -16
View File
@@ -2,51 +2,51 @@
# Kotlin/Native #
_Kotlin/Native_ is a LLVM backend for the Kotlin compiler, runtime
implementation and native code generation facility using LLVM toolchain.
_Kotlin/Native_ is an LLVM backend for the Kotlin compiler, runtime
implementation, and native code generation facility using the LLVM toolchain.
_Kotlin/Native_ is primarily designed to allow compilation for platforms where
virtual machines are not desirable or possible (such as iOS, embedded targets),
virtual machines are not desirable or possible (such as iOS or embedded targets),
or where a developer is willing to produce a reasonably-sized self-contained program
without the need to ship an additional execution runtime.
Prerequesties:
Prerequisites:
install JDK for your platform, instead of JRE. The build requires ```tools.jar```, which is not included in JRE.
To compile from sources use following steps.
To compile from sources use following steps:
First download dependencies:
First, download dependencies:
./gradlew dependencies:update
Then build the compiler and libraries:
Then, build the compiler and libraries:
./gradlew bundle
The build can take about an hour on a Macbook Pro.
To run a shorter build with only host compiler and libraries run:
To run a shorter build with only the host compiler and libraries, run:
./gradlew dist distPlatformLibs
After that you should be able to compile your programs like that:
After that, you should be able to compile your programs like this:
export PATH=./dist/bin:$PATH
kotlinc hello.kt -o hello
For an optimized compilation use `-opt`:
For an optimized compilation, use `-opt`:
kotlinc hello.kt -o hello -opt
For some tests, use:
For tests, use:
./gradlew backend.native:tests:run
To generate interoperability stubs create library definition file
(take a look on [`samples/tetris/.../sdl.def`](https://github.com/JetBrains/kotlin-native/blob/master/samples/tetris/src/main/c_interop/sdl.def)) and run `cinterop` tool like this:
To generate interoperability stubs, create a library definition file
(refer to [`samples/tetris/.../sdl.def`](https://github.com/JetBrains/kotlin-native/blob/master/samples/tetris/src/main/c_interop/sdl.def)), and run the `cinterop` tool like this:
cinterop -def lib.def
See provided [samples](https://github.com/JetBrains/kotlin-native/tree/master/samples) and [`INTEROP.md`](https://github.com/JetBrains/kotlin-native/blob/master/INTEROP.md) for more details.
See the provided [samples](https://github.com/JetBrains/kotlin-native/tree/master/samples) and [`INTEROP.md`](https://github.com/JetBrains/kotlin-native/blob/master/INTEROP.md) for more details.
Interop tool generates library in .klib library format, see [`LIBRARIES.md`](https://github.com/JetBrains/kotlin-native/blob/master/LIBRARIES.md)
for more details on the file format.
The Interop tool generates a library in the `.klib` library format. See [`LIBRARIES.md`](https://github.com/JetBrains/kotlin-native/blob/master/LIBRARIES.md)
for more details on this file format.