Move everything under kotlin-native folder

I was forced to manually do update the following files, because otherwise they would be ignored according .gitignore settings. Probably they should be deleted from repo. Interop/.idea/compiler.xml Interop/.idea/gradle.xml Interop/.idea/libraries/Gradle__org_jetbrains_kotlin_kotlin_runtime_1_0_3.xml Interop/.idea/libraries/Gradle__org_jetbrains_kotlin_kotlin_stdlib_1_0_3.xml Interop/.idea/modules.xml Interop/.idea/modules/Indexer/Indexer.iml Interop/.idea/modules/Runtime/Runtime.iml Interop/.idea/modules/StubGenerator/StubGenerator.iml backend.native/backend.native.iml backend.native/bc.frontend/bc.frontend.iml backend.native/cli.bc/cli.bc.iml backend.native/cli.bc/src/org/jetbrains/kotlin/cli/bc/K2Native.kt backend.native/cli.bc/src/org/jetbrains/kotlin/cli/bc/K2NativeCompilerArguments.kt backend.native/tests/link/lib/foo.kt backend.native/tests/link/lib/foo2.kt backend.native/tests/teamcity-test.property
2020-10-27 21:00:28 +03:00
parent 91e4162dad
commit f624800b84
2830 changed files with 0 additions and 0 deletions
@@ -0,0 +1,61 @@
+# Platform libraries
+
+## Overview
+
+To provide access to user's native operating system services,
+`Kotlin/Native` distribution includes a set of prebuilt libraries specific to
+each target. We call them **Platform Libraries**.
+
+### POSIX bindings
+
+For all `Unix` or `Windows` based targets (including `Android` and
+`iOS`) we provide the `posix` platform lib. It contains bindings
+to platform's implementation of `POSIX` standard.
+
+To use the library just 
+
+<div class="sample" markdown="1" theme="idea" data-highlight-only>
+
+```kotlin
+import platform.posix.*
+```
+
+</div> 
+
+The only target for which it is not available is [WebAssembly](https://en.wikipedia.org/wiki/WebAssembly).
+
+Note that the content of `platform.posix` is NOT identical on
+different platforms, in the same way as different `POSIX` implementations
+are a little different.
+
+
+### Popular native libraries
+
+There are many more platform libraries available for host and
+cross-compilation targets.  `Kotlin/Native` distribution provides access to
+`OpenGL`, `zlib` and other popular native libraries on
+applicable platforms.
+
+On Apple platforms `objc` library is provided for interoperability with [Objective-C](https://en.wikipedia.org/wiki/Objective-C).
+
+Inspect the contents of `dist/klib/platform/$target` of the distribution for the details.
+
+## Availability by default
+
+The packages from platform libraries are available by default. No
+special link flags need to be specified to use them. `Kotlin/Native`
+compiler automatically detects which of the platform libraries have
+been accessed and automatically links the needed libraries.
+
+On the other hand, the platform libs in the distribution are merely
+just wrappers and bindings to the native libraries.  That means the
+native libraries themselves (`.so`, `.a`, `.dylib`, `.dll` etc)
+should be installed on the machine.
+
+## Examples
+
+`Kotlin/Native` installation provides a wide spectrum of examples
+demonstrating the use of platform libraries. 
+See [samples](https://github.com/JetBrains/kotlin-native/tree/master/samples) for details.
+
+