Add the information about linkerOpts into doc 'Getting Start'

ctripcorp · Oct 10, 2023 · 3b11e66 · 3b11e66
1 parent f02256c
commit 3b11e66
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/sqllin-dsl/doc/getting-start-cn.md b/sqllin-dsl/doc/getting-start-cn.md
@@ -4,7 +4,7 @@
 
 ## 在 Gradle 中使用 Maven 引入
 
-将 _sqllin-dsl_、_sqllin-driver_ 以及 _sqllin-processor_ 依赖添加到你的 build.gradle.kts：
+将 _sqllin-dsl_、_sqllin-driver_ 以及 _sqllin-processor_ 依赖添加到你的 `build.gradle.kts`：
 
 ```kotlin
 plugins {
@@ -41,6 +41,8 @@ dependencies {
     add("kspCommonMainMetadata", "com.ctrip.kotlin:sqllin-processor:$sqllinVersion")
 }
 ```
+> 注意：如果你想将 SQLlin 的依赖添加到你的 Kotlin/Native 可执行程序工程，有时你需要正确添加对 SQLite 的 `linkerOpts` 到你的
+> `build.gradle.kts`。你可以参考 [issue #48](https://github.com/ctripcorp/SQLlin/issues/48) 来获取更多信息。
 
 ## 创建数据库
 

diff --git a/sqllin-dsl/doc/getting-start.md b/sqllin-dsl/doc/getting-start.md
@@ -4,9 +4,9 @@
 
 **Welcome to use SQLlin !!!**
 
-## Installation via Maven in Gradle
+## Installation via Maven with Gradle
 
-Add the _sqllin-dsl_, _sqllin-driver_ and _sqllin-processor_ dependencies in your build.gradle.kts: 
+Add the _sqllin-dsl_, _sqllin-driver_ and _sqllin-processor_ dependencies into your `build.gradle.kts`: 
 
 ```kotlin
 plugins {
@@ -44,6 +44,9 @@ dependencies {
 }
 ```
 
+> Note: If you want to add dependiences of SQLlin into your Kotlin/Native exectable program project, sometimes you need to add the `linkerOpts`
+> of SQLite into your `build.gradle.kts` correctly. You can refer to [issue #48](https://github.com/ctripcorp/SQLlin/issues/48) to get more information.
+
 ## Creating the Database
 
 You can create the `Database` instance in sample: