diff --git a/docs/guide-zh-CN.md b/docs/guide-zh-CN.md index 1525fdc..0e826d4 100644 --- a/docs/guide-zh-CN.md +++ b/docs/guide-zh-CN.md @@ -22,82 +22,10 @@ Flexi UI 分为 `core` 与 `resources` 两个模块,通常情况下你只需 这是一个 Kotlin Multiplatform 依赖,你需要 `org.jetbrains.kotlin.multiplatform` 插件来应用相关依赖。 -我们推荐使用 Kotlin DSL 作为 Gradle 构建脚本语言并推荐使用 [SweetDependency](https://github.com/HighCapable/SweetDependency) 来管理依赖。 - -### SweetDependency (推荐) - -在你的项目 `SweetDependency` 配置文件中添加依赖。 - -```yaml -libraries: - com.highcapable.flexiui: - # commonMain - core: - version: + - resources: - version: + - # androidMain - core-android: - version-ref: ::core - resources-android: - version-ref: ::resources - # iosArm64Main - core-iosarm64: - version-ref: ::core - resources-iosarm64: - version-ref: ::resources - # iosX64Main - core-iosx64: - version-ref: ::core - resources-iosx64: - version-ref: ::resources - # iosSimulatorArm64Main - core-iossimulatorarm64: - version-ref: ::core - resources-iossimulatorarm64: - version-ref: ::resources - # desktopMain - core-desktop: - version-ref: ::core - resources-desktop: - version-ref: ::resources -``` +我们推荐使用 Kotlin DSL 作为 Gradle 构建脚本语言。 在你的项目 `build.gradle.kts` 中配置依赖。 -如果你在普通的项目中使用多平台依赖,你只需要按需部署对应平台后缀的依赖即可。 - -```kotlin -implementation(com.highcapable.flexiui.core.android) -implementation(com.highcapable.flexiui.core.iosarm64) -implementation(com.highcapable.flexiui.core.iosx64) -implementation(com.highcapable.flexiui.core.iossimulatorarm64) -implementation(com.highcapable.flexiui.core.desktop) -``` - -```kotlin -implementation(com.highcapable.flexiui.resources.android) -implementation(com.highcapable.flexiui.resources.iosarm64) -implementation(com.highcapable.flexiui.resources.iosx64) -implementation(com.highcapable.flexiui.resources.iossimulatorarm64) -implementation(com.highcapable.flexiui.resources.desktop) -``` - -如果你在多平台项目中使用多平台依赖,你需要在 `commonMain` 中添加 `core` 依赖。 - -```kotlin -kotlin { - sourceSets { - val commonMain by getting { - dependencies { - implementation(com.highcapable.flexiui.core) - implementation(com.highcapable.flexiui.resources) - } - } - } -} -``` - ### 传统方式 在你的项目 `build.gradle.kts` 中配置依赖。 diff --git a/docs/guide.md b/docs/guide.md index 337cab1..5f50051 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -25,82 +25,7 @@ You can add this module to your project using the following method. This is a Kotlin Multiplatform dependency, you need the `org.jetbrains.kotlin.multiplatform` plugin to apply the relevant dependencies. -We recommend using Kotlin DSL as the Gradle build script language and [SweetDependency](https://github.com/HighCapable/SweetDependency) -to manage dependencies. - -### SweetDependency (Recommended) - -Add dependencies to your project `SweetDependency` configuration file. - -```yaml -libraries: - com.highcapable.flexiui: - # commonMain - core: - version: + - resources: - version: + - # androidMain - core-android: - version-ref: ::core - resources-android: - version-ref: ::resources - # iosArm64Main - core-iosarm64: - version-ref: ::core - resources-iosarm64: - version-ref: ::resources - # iosX64Main - core-iosx64: - version-ref: ::core - resources-iosx64: - version-ref: ::resources - # iosSimulatorArm64Main - core-iossimulatorarm64: - version-ref: ::core - resources-iossimulatorarm64: - version-ref: ::resources - # desktopMain - core-desktop: - version-ref: ::core - resources-desktop: - version-ref: ::resources -``` - -Configure dependencies in your project `build.gradle.kts`. - -If you use multi-platform dependencies in a regular project, you only need to deploy the corresponding platform suffix dependencies as needed. - -```kotlin -implementation(com.highcapable.flexiui.core.android) -implementation(com.highcapable.flexiui.core.iosarm64) -implementation(com.highcapable.flexiui.core.iosx64) -implementation(com.highcapable.flexiui.core.iossimulatorarm64) -implementation(com.highcapable.flexiui.core.desktop) -``` - -```kotlin -implementation(com.highcapable.flexiui.resources.android) -implementation(com.highcapable.flexiui.resources.iosarm64) -implementation(com.highcapable.flexiui.resources.iosx64) -implementation(com.highcapable.flexiui.resources.iossimulatorarm64) -implementation(com.highcapable.flexiui.resources.desktop) -``` - -If you use multi-platform dependencies in a multi-platform project, you need to add the `core` dependency in `commonMain`. - -```kotlin -kotlin { - sourceSets { - val commonMain by getting { - dependencies { - implementation(com.highcapable.flexiui.core) - implementation(com.highcapable.flexiui.resources) - } - } - } -} -``` +We recommend using Kotlin DSL as the Gradle build script language. ### Traditional Method