Update the project name + minor corrections (#437)

- Kotlin N -> Kotlin/Native
- Some wording corrections
This commit is contained in:
Andrey Breslav
2017-04-03 14:50:59 +03:00
committed by Nikolay Igotti
parent 88dec13625
commit d997d26104
+13 -14
View File
@@ -1,23 +1,22 @@
# Early Access Preview of Kotlin Native # # Early Access Preview of Kotlin/Native #
## Introduction ## ## Introduction ##
_Kotlin/Native_, is a LLVM backend for the Kotlin compiler. Kotlin/Native is a LLVM backend for the Kotlin compiler. It consists of a machine code generation facility using the LLVM toolchain
It consists of a native code generation facility using the LLVM toolchain
and a native runtime implementation. and a native runtime implementation.
_Kotlin/Native_ is primarily designed to allow compilation for platforms where _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 the developer needs to produce a reasonably-sized self-contained program or where the developer needs to produce a reasonably-sized self-contained binary
that doesn't require an additional execution runtime. that doesn't require an additional execution runtime.
## Supported platforms ## ## Supported platforms ##
_Kotlin/Native_ compiler produces mostly portable (modulo pointer size and target The _Kotlin/Native_ compiler produces mostly portable (modulo pointer size and target
triplet) LLVM bitcode, and as such can easily support any platform, as long as there's a LLVM triplet) LLVM bitcode, and as such can easily support any platform, as long as there's an LLVM
codegenerator for the platform. code generator for the platform.
However, as actual producing of the native code requires a platform linker and some However, as actualy producing native code requires a platform linker and some
basic runtime shipped with the translator, we only support a subset of all possible basic runtime shipped along with the translator, we only support a subset of all possible
target platforms. Currently _Kotlin/Native_ is being shipped and tested with support for target platforms. Currently _Kotlin/Native_ is being shipped and tested with support for
the following platforms: the following platforms:
@@ -37,13 +36,13 @@ To run _Kotlin/Native_ JDK8 or later for the host platform has to be installed.
The language and library version supported by this EAP release mostly match Kotlin 1.1. The language and library version supported by this EAP release mostly match Kotlin 1.1.
However, there are certain limitations, see section [Known Limitations](#limitations). However, there are certain limitations, see section [Known Limitations](#limitations).
Currently _Kotlin/Native_ uses reference counting based memory management scheme with cycles Currently _Kotlin/Native_ uses reference counting based memory management scheme with a cycle
garbage collection algorithm. Multiple threads could be used, but no objects shared collection algorithm. Multiple threads could be used, but no objects shared
between threads are allowed. between threads are allowed.
_Kotlin/Native_ provides efficient interoperability with libraries written in C, and supports _Kotlin/Native_ provides efficient interoperability with libraries written in C, and supports
automatic generation of Kotlin bindings from a C header file. automatic generation of Kotlin bindings from a C header file.
See samples coming with the distribution. See the samples coming with the distribution.
## Getting Started ## ## Getting Started ##
@@ -82,6 +81,6 @@ Notice that property delegation (including lazy properties) *does* work.
### Microsoft Windows support ### ### Microsoft Windows support ###
Due to significant difference in exception handling model on MS Windows and Due to significant differences in exception handling models on MS Windows and
other LLVM targets, current _Kotlin/Native_ may not produce executables working on other LLVM targets, current _Kotlin/Native_ may not produce executables working on
MS Windows. This situation could be improved in upcoming releases. MS Windows. This situation could be improved in upcoming releases.