From 06a3f0164e47c0ba8cc328bf1dc77e0dc1813bdf Mon Sep 17 00:00:00 2001 From: Kevin Schildhorn Date: Mon, 10 Aug 2026 13:54:34 -0400 Subject: [PATCH 1/2] Update README.md --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1c3aa75..b5d5e20 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ CKlib is a gradle plugin that will build and package C/C++/Objective-C code for Kotlin/Native. -# Usage +> **Note:** 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. +## Usage Add gradle plugins @@ -24,7 +25,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 @@ -41,10 +42,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 ======= From d582bb0cfb777c39fcb710f8cd060612b1aadcac Mon Sep 17 00:00:00 2001 From: Kevin Schildhorn Date: Mon, 10 Aug 2026 14:46:15 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index b5d5e20..84f4657 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ CKlib is a gradle plugin that will build and package C/C++/Objective-C code for Kotlin/Native. -> **Note:** 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. ## Usage Add gradle plugins