1 ../README.md

     1 [![Release Version](https://img.shields.io/maven-central/v/com.geekorum.aboutoss/core?label=release)](https://search.maven.org/#search%7Cga%7C1%7Caboutoss)

     2 [![License](https://img.shields.io/github/license/fbarthelery/AboutOss)](https://github.com/fbarthelery/AboutOss/blob/main/LICENSE)

     3 

     4 AboutOss

     5 ==========

     6 

     7 AboutOss is a Kotlin Multiplatform utility library to retrieve and display opensource licenses in your applications.

     8 

     9 ```kotlin title="build.gradle.kts"

    10 implementation("com.geekorum.aboutoss:ui-material3:<latest-version>")

    11 ```

    12 

    13 License sources

    14 ---------------

    15 

    16 The library can work with license information files generated by:

    17 

    18 - [OSS Licenses Gradle Plugin](https://github.com/google/play-services-plugins/tree/main/oss-licenses-plugin)

    19 - [licensee](https://github.com/cashapp/licensee)

    20 - [LicensePlist](https://github.com/mono0926/LicensePlist)

    21 

    22 See [license sources](license-sources.md) for more information

    23 

    24 User interface

    25 --------------

    26 

    27 The user interface to display license information is written in [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform).

    28 There is out of the box composables for Material and Material3 and you can easily write your own UI.

    29 

    30 Check the sample [here](https://github.com/fbarthelery/AboutOss/tree/main/sample)

    31 

    32 Build instructions

    33 ==================

    34 

    35 Just use Gradle to build

    36 

    37     ./gradlew build

    38 

    39 

    40 License

    41 =======

    42 

    43 AboutOss is an open source library and is licensed under the GNU General Public License 3 and any later version.

    44 This means that you can get AboutOss's code and modify it to suit your needs, as long as you publish the changes

    45 you make for everyone to benefit from as well.

    46 

    47 AboutOss is built and maintained by community volunteers.