From fe724be1880a9802ed40554b16ebfa79a76cf97a Mon Sep 17 00:00:00 2001 From: Sergio Belda Galbis Date: Sun, 14 Jan 2024 00:33:30 +0100 Subject: [PATCH] Delete docs directory --- docs/android.md | 38 ------------------------------------ docs/multiplatform.md | 45 ------------------------------------------- 2 files changed, 83 deletions(-) delete mode 100644 docs/android.md delete mode 100644 docs/multiplatform.md diff --git a/docs/android.md b/docs/android.md deleted file mode 100644 index 10dc61a..0000000 --- a/docs/android.md +++ /dev/null @@ -1,38 +0,0 @@ -## How to Use - -### Android - -```kotlin -plugins { - id("com.android.application") - id("org.jetbrains.kotlin.android") - id("dev.sergiobelda.compose.vectorize") version "$VERSION" -} - -dependencies { - implementation("dev.sergiobelda.compose.vectorize:compose-vectorize-core:$VERSION") -} - -composeVectorize { - packageName = "dev.example.myproject" // Custom package name -} -``` - -Create a folder called `xml-images` in the module folder. For example, if you're using this plugin in your application module called `app`, you need to create a folder inside the app folder. - -`app/xml-images` - -Captura de pantalla 2024-01-05 a las 16 57 56 - -You can manually generate ImageVector for these XML files by calling `gradle generateImages`. This will create a Kotlin file for each XML file containing the ImageVector in the build folder. - -Captura de pantalla 2024-01-05 a las 17 00 45 -

- -Now, you can use reference this image in the Compose code: - -```kotlin -Icon(Images.Icons.Add, contentDescription = null) -``` - -Note that automatically a category called "Icons" has been created. A category is created for each subfolder in `xml-images` folder. diff --git a/docs/multiplatform.md b/docs/multiplatform.md deleted file mode 100644 index 10a546e..0000000 --- a/docs/multiplatform.md +++ /dev/null @@ -1,45 +0,0 @@ -## How to Use - -### Multiplatform - -```kotlin -plugins { - kotlin("multiplatform") - id("org.jetbrains.compose") - id("dev.sergiobelda.compose.vectorize") version "$VERSION" -} - -kotlin { - sourceSets { - val commonMain by getting { - dependencies { - implementation(compose.ui) - implementation("dev.sergiobelda.compose.vectorize:compose-vectorize-core:$VERSION") - } - } - } -} - -composeVectorize { - packageName = "dev.example.myproject" // Custom package name -} -``` - -Create a folder called `xml-images` in the module folder. For example: - -`common/xml-images` - -Captura de pantalla 2024-01-05 a las 17 10 28 - -You can manually generate ImageVector for these XML files by calling `gradle generateImages`. This will create a Kotlin file for each XML file containing the ImageVector in the build folder. - -Captura de pantalla 2024-01-05 a las 17 12 08 -

- -Now, you can use reference this image in the Compose code: - -```kotlin -Icon(Images.Icons.Add, contentDescription = null) -``` - -Note that automatically a category called "Icons" has been created. A category is created for each subfolder in `xml-images` folder.