AboutLibraries

To run the iOS application, follow these steps:

1. Set up a Kotlin Multiplatform environment.
2. Install the Kotlin Multiplatform Mobile plugin.
3. Open the project in IntelliJ IDEA or Android Studio.
4. Add a new run configuration for the iOS Application.
5. Run the iOS Application.

You can add or override funding details for libraries using two methods:

1. Manual: Place a funding.json file in the funding directory within your configured configPath.
2. Automatic: Use the exportFunding Gradle task to generate this data automatically. To use this method, you must provide a GitHub API Key.

Note: The exportFunding task will overwrite the existing file if it already exists.

./gradlew app:exportFunding

To verify screenshot tests and generate a report in the Android module, run:

./gradlew :sample:android:verifyPaparazzi

Install and run the debug version of the Android application using Gradle:

./gradlew :sample:installDebug

Run the desktop application using the following Gradle task:

./gradlew :sample:desktop:run

To export library definitions for the different platforms in the sample project, run the following Gradle tasks for the shared, desktop, and web modules:

./gradlew :sample:shared:exportLibraryDefinitions
./gradlew :sample:desktop:exportLibraryDefinitions
./gradlew :sample:web:exportLibraryDefinitions

For Jetpack Compose applications, include the appropriate Material 2 or Material 3 UI modules in your build.gradle.kts file.

// build.gradle.kts
// Recommended: Using version catalog (choose M2 or M3, or both)
implementation(libs.aboutlibraries.compose.m2) // Material 2
implementation(libs.aboutlibraries.compose.m3) // Material 3

// Alternative: Direct dependency declaration
// implementation("com.mikepenz:aboutlibraries-compose:${latestAboutLibsRelease}") // Material 2
// implementation("com.mikepenz:aboutlibraries-compose-m3:${latestAboutLibsRelease}") // Material 3

Use the following command to record reference images required for Paparazzi screenshot tests in the Android module:

./gradlew :sample:android:recordPaparazzi

To export the library definitions and dependency information from the standard application module, run the following Gradle command:

./gradlew :app:exportLibraryDefinitions

If you are developing an Android project and want library definitions to be automatically generated as part of the Android build process, use the Android-specific plugin. This plugin automatically hooks into the build, includes the generated file in Android resources, and requires no manual task execution.

// Root build.gradle.kts
id("com.mikepenz.aboutlibraries.plugin.android") version "${latestAboutLibsRelease}" apply false

// App build.gradle.kts
id("com.mikepenz.aboutlibraries.plugin.android")

When working with Android-specific builds, use the debug variant task to export the library definitions and dependency information:

./gradlew :app:exportLibraryDefinitionsDebug