From 2aa18d5833574aca33ec62ac4f37dc58e3a54cd0 Mon Sep 17 00:00:00 2001 From: Tristan Greeno Date: Tue, 21 Nov 2017 03:04:40 -0600 Subject: [PATCH] update readme to fix grammar, spelling, wording (#1058) I have updated the Readme markdown file to fix certain grammar and spelling issues. --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index f6668c257a3..ac53020b515 100644 --- a/README.md +++ b/README.md @@ -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.