| author | Da Risk <da_risk@geekorum.com> |
| Tue, 06 May 2025 10:37:57 -0400 | |
| changeset 85 | 0c23a1d2e16a |
| parent 84 | f1e51fe391c2 |
| child 90 | 260a6b232f4d |
| permissions | -rw-r--r-- |
|
7
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
1 |
AboutOss |
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
2 |
========== |
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
3 |
|
|
84
f1e51fe391c2
docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
75
diff
changeset
|
4 |
AboutOss is a Kotlin Multiplatform utility library to retrieve and display opensource licenses in your applications. |
|
7
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
5 |
|
|
84
f1e51fe391c2
docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
75
diff
changeset
|
6 |
License sources |
|
f1e51fe391c2
docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
75
diff
changeset
|
7 |
--------------- |
|
7
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
8 |
|
|
84
f1e51fe391c2
docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
75
diff
changeset
|
9 |
The library can work with license information files generated by: |
|
7
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
10 |
|
|
84
f1e51fe391c2
docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
75
diff
changeset
|
11 |
- [OSS Licenses Gradle Plugin](https://github.com/google/play-services-plugins/tree/main/oss-licenses-plugin) |
|
f1e51fe391c2
docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
75
diff
changeset
|
12 |
- [licensee](https://github.com/cashapp/licensee) |
|
f1e51fe391c2
docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
75
diff
changeset
|
13 |
- [LicensePlist](https://github.com/mono0926/LicensePlist) |
|
7
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
14 |
|
|
84
f1e51fe391c2
docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
75
diff
changeset
|
15 |
User interface |
|
f1e51fe391c2
docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
75
diff
changeset
|
16 |
-------------- |
|
7
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
17 |
|
|
84
f1e51fe391c2
docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
75
diff
changeset
|
18 |
The user interface to display license information is written in [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform). |
|
f1e51fe391c2
docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
75
diff
changeset
|
19 |
There is out of the box composables for Material and Material3 and you can easily write your own UI. |
|
7
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
20 |
|
|
84
f1e51fe391c2
docs: add documentation for different license sources and UI
Da Risk <da_risk@geekorum.com>
parents:
75
diff
changeset
|
21 |
Check the sample [here](https://github.com/fbarthelery/AboutOss/tree/main/sample) |
|
7
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
22 |
|
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
23 |
Build instructions |
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
24 |
================== |
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
25 |
|
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
26 |
Just use Gradle to build |
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
27 |
|
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
28 |
./gradlew build |
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
29 |
|
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
30 |
|
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
31 |
License |
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
32 |
======= |
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
33 |
|
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
34 |
AboutOss is an open source library and is licensed under the GNU General Public License 3 and any later version. |
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
35 |
This means that you can get AboutOss's code and modify it to suit your needs, as long as you publish the changes |
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
36 |
you make for everyone to benefit from as well. |
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
37 |
|
|
b3b2e88f441f
add README.md and maven publications
Da Risk <da_risk@geekorum.com>
parents:
diff
changeset
|
38 |
AboutOss is built and maintained by community volunteers. |