Skip to content

Update README.md #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KevinSchildhorn wants to merge 2 commits into
base: main
Choose a base branch
from
+10 −5
Open

Update README.md #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06a3f01
Update README.md
KevinSchildhorn Aug 10, 2026
d582bb0
Update README.md
KevinSchildhorn Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

CKlib is a gradle plugin that will build and package C/C++/Objective-C code for Kotlin/Native.

# Usage
## Usage

Add gradle plugins

Expand All @@ -24,7 +24,7 @@ cklib {
}
```

See example in [Kermit](https://github.com/touchlab/Kermit/blob/main/kermit-crashlytics-test/build.gradle.kts#L69)
## Configuration

Configuring custom C Standard and llvmHome.
```kotlin
Expand All @@ -41,10 +41,15 @@ cklib {
- Default `cStandard`: `gnu11`
- Default `cppStandard`: `c++17`

# Note
## Examples

You can find a [tutorial](https://hackernoon.com/how-to-extend-a-kmm-shared-module-with-cc-code) with a [GitHub Sample](https://github.com/ttypic/kmm-embedded-c) to get a brief understanding of how the library works.

Additionally you can see multiple examples of C Klib in use here:
1. [zstd-kmp](https://github.com/square/zstd-kmp) - Packages [ztsd](https://github.com/facebook/zstd), a fast real-time compression algorithm.
1. [Zipline](https://github.com/cashapp/zipline) - Packages [QuickJS](https://bellard.org/quickjs/), a small and embeddable Javascript engine.


The main Kotlin project has changed how locally embedded C-like code is included in libraries. Use
this project if you'd like, but outside of private projects we won't really be supporting it much.

License
=======
Expand Down