{"id":13609007,"url":"https://github.com/cyb3rko/about-icons","last_synced_at":"2025-04-12T17:33:41.309Z","repository":{"id":145423042,"uuid":"279903837","full_name":"cyb3rko/about-icons","owner":"cyb3rko","description":"Android library to easily give credit if using icons which require attribution","archived":true,"fork":false,"pushed_at":"2022-10-03T16:17:27.000Z","size":14913,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-07T14:42:43.005Z","etag":null,"topics":["android","attribution","credits","icons","library"],"latest_commit_sha":null,"homepage":"https://play.google.com/store/apps/details?id=com.cyb3rko.abouticonssample","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cyb3rko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-07-15T15:21:09.000Z","updated_at":"2024-09-09T18:11:36.000Z","dependencies_parsed_at":"2023-05-25T20:30:37.697Z","dependency_job_id":null,"html_url":"https://github.com/cyb3rko/about-icons","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyb3rko%2Fabout-icons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyb3rko%2Fabout-icons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyb3rko%2Fabout-icons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyb3rko%2Fabout-icons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cyb3rko","download_url":"https://codeload.github.com/cyb3rko/about-icons/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248605507,"owners_count":21132184,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","attribution","credits","icons","library"],"created_at":"2024-08-01T19:01:31.667Z","updated_at":"2025-04-12T17:33:36.294Z","avatar_url":"https://github.com/cyb3rko.png","language":"Kotlin","funding_links":[],"categories":["Kotlin"],"sub_categories":[],"readme":"# Android About Icons Library\n[![API](https://img.shields.io/badge/API-16%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=16)\n[![Jitpack](https://jitpack.io/v/cyb3rko/about-icons.svg)](https://jitpack.io/#cyb3rko/about-icons)\n[![last commit](https://img.shields.io/github/last-commit/cyb3rko/about-icons?color=F34C9F)](https://github.com/cyb3rko/about-icons/commits/master)\n[![license](https://img.shields.io/github/license/cyb3rko/about-icons)](https://www.apache.org/licenses/LICENSE-2.0)\n\n- [About this project](#about-this-project)  \n- [Features](#features)  \n- [How to use](#how-to-use)  \n- [Planned improvements](#planned-improvements)  \n- [Screenshots](#screenshots)  \n- [Contribute](#contribute)  \n- [Apps using this library](#apps-using-this-library)  \n- [License](#license)  \n\n---\n\n## About this project\nThis Android library simplifies the exhausting process of giving credits to licensed icons which require attribution (like icons from [flaticon.com](https://flaticon.com) or [fontawesome.com](https://fontawesome.com) in the free plan).\n\nYOU CAN **DOWNLOAD** THE **SAMPLE APP** here:  \n\n\u003ca href=\"https://play.google.com/store/apps/details?id=com.cyb3rko.abouticonssample\"\u003e\u003cimg src=\"https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png\" width=\"250\"/\u003e\u003c/a\u003e\n\nIf you want to build the app on your own, build the debug build variant.\n\nThis was my very first library and I'm still a student so the progress might not be as fast as on other projects.\n\n## Features\n- automatically recognizing the icons to show based on file name (further information [here](#2-mark-icons))\n- automatically retrieving the information and credits by reading related string arrays (further information [here](#3-add-information))\n- automatically highlight icons who have been modified by reading related string entry (further information [here](#3-add-information))\n\n## How to use\n\n### 1. Implementation\nAdd this to your **root** build.gradle file:\n```gradle\nallprojects {\n  repositories {\n    maven { url \"https://jitpack.io\" }\n  }\n}\n```\n\nThen add this to your **module's** build.gradle file:\n```gradle\ndependencies {\n  implementation 'com.github.cyb3rko:about-icons:lastest-version'\n}\n```\n\n### 2. Mark icons\nAfterwards you have to add an underscore to every icon filename you want the library to attribute.  \nIf you don't add an underscore, the icon is ignored.\n\n**Example**:  \n\u003cimg src=\".github/images/mark_icons.webp\" width=\"230\"\u003e\n          \n### 3. Add information\nNow you have to add the information the library needs for attributing.  \nDo this by adding a string array for each icon with the icon name as string array name (**without** the underscore; it doesn't matter in which .xml file):\n- author name (should be added)\n- website (should be added)\n- link to the used icon (should be added)\n- boolean if icon was modified (default is *false*)\n- icon license (currently supported licenses (if you are missing one, please [open an issue](https://github.com/cyb3rko/about-icons/issues/new) for the used [licenses library](https://github.com/cyb3rko/android-licenses-library))): \n  - [apache_2.0](https://www.apache.org/licenses/LICENSE-2.0)\n  - [mit](https://opensource.org/licenses/MIT)\n  - [cc_by_3.0](https://creativecommons.org/licenses/by/3.0/)\n  - [cc_by_sa_3.0](https://creativecommons.org/licenses/by-sa/3.0/)\n  - [cc_by_4.0](https://creativecommons.org/licenses/by/4.0/)\n  - [cc_by_sa_4.0](https://creativecommons.org/licenses/by-sa/4.0/)\n  - [cc_by_nc_3.0](https://creativecommons.org/licenses/by-nc/3.0/)\n\n```xml\n\u003c?xml version=\"1.0\" encoding=\"utf-8\"?\u003e\n\u003cresources\u003e\n    \u003cstring-array name=\"icon_alink\"\u003e\n        \u003citem\u003eDave Gandy\u003c/item\u003e\n        \u003citem\u003eflaticon.com\u003c/item\u003e\n        \u003citem\u003ehttps://www.flaticon.com/free-icon/external-link-symbol_25284\u003c/item\u003e\n        \u003citem\u003efalse\u003c/item\u003e\n        \u003citem\u003ecc_by_3.0\u003c/item\u003e\n    \u003c/string-array\u003e\n\n    \u003cstring-array name=\"icon_art\"\u003e\n        \u003citem\u003exnimrodx\u003c/item\u003e\n        \u003citem\u003eflaticon.com\u003c/item\u003e\n        \u003citem\u003ehttps://www.flaticon.com/free-icon/computer_2905155\u003c/item\u003e\n    \u003c/string-array\u003e\n    ...\n\u003c/resources\u003e\n```\n\n### 4. Create view\nAt last just create a new `AboutIcons` object, pass the context and the drawable class, and get the view by calling `get()`.  \nOptionally you can configure your AboutIcons page using following config methods:\n```java\n.setTitle(customTitle: String)\n.setTitleSize(customSize: Float)\n.setModificationTitle(customTitle: String)\n.setModificationTitleSize(customSize: Float)\n.hideModificationAnnotation()\n```\n*HINT*: If you want to hide the title, simply call \"setTitle(\"\")\", then the title layout will be hidden\n\n**Simple example for a fragment**:\nKotlin\n```kotlin\noverride fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View {\n    super.onCreateView(inflater, container, savedInstanceState)\n\n    return AboutIcons(requireContext(), R.drawable::class.java, supportFragmentManager).get()\n}\n```\nJava Activity\n```java\n@Override\nprotected void onCreate(Bundle savedInstanceState) {\n    super.onCreate(savedInstanceState);\n    setContentView(new AboutIcons(this, R.drawable.class, getSupportFragmentManager()).get());\n}\n```\n\n**Advanced example (using configuration) for a fragment**:\u003cbr/\u003e\nKotlin:\n```kotlin\noverride fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View {\n    super.onCreateView(inflater, container, savedInstanceState)\n    \n    val aboutIcons = AboutIcons(requireContext(), R.drawable::class.java, supportFragmentManager)\n            .setTitle(\"Your Title\")\n            .hideModificationAnnotation();\n\n     return aboutIcons.get()\n}\n```\nJava Activity:\n```java\n@Override\nprotected void onCreate(Bundle savedInstanceState) {\n    super.onCreate(savedInstanceState);\n    \n    AboutIcons aboutIcons = new AboutIcons(this, R.drawable.class, getSupportFragmentManager())\n            .setTitle(\"Your Title\")\n            .setModificationTitleSize(6f)\n            .hideModificationAnnotation();\n\n    setContentView(aboutIcons.get());\n}\n```\n\n## Proguard Minify Compatibility\nIf you have minify enabled and you let it shrink the resources this library is most likely to not be able to find your icons you want to give credit to.\n\nThen simply add the following to your proguard rules:\n\n```pro\n-keep class .R\n-keep class **.R$* {\n    \u003cfields\u003e;\n}\n```\n\n## Planned improvements\n- improving scroll performance\n- adding simple licensing information for several icon library websites\n\n## Screenshots\n|\u003cimg src=\".github/images/v1.5.0/screenshot_1.png\" width=\"270\"\u003e|\u003cimg src=\".github/images/v1.5.0/screenshot_2.png\" width=\"270\"\u003e|\u003cimg src=\".github/images/v1.5.0/screenshot_3.png\" width=\"270\"\u003e|\n|:---:|:---:|:---:|\n\n## Contribute\nOf course I'm happy about any kind of contribution.\n\nFeel free to open [issues](https://github.com/cyb3rko/about-icons/issues) for new features or bug reports.\nIf you want to directly contribute code just open [pull requests](https://github.com/cyb3rko/about-icons/pulls).\n\n## Apps using this library\n*If you want to add an app here, just open a [new issue](https://github.com/cyb3rko/about-icons/issues/new) / [PR](https://github.com/cyb3rko/about-icons/compare).*\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ca href=\"https://github.com/cyb3rko/logviewer-for-openhab-app\"\u003e\u003cimg src=\"https://i.imgur.com/a6RbPkJ.png\" width=\"48\"/\u003e\u003c/a\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://github.com/cyb3rko/logviewer-for-openhab-app\"\u003eLogViewer for openHAB\u003c/a\u003e\u003c/td\u003e\n    \u003ctd\u003eby \u003ca href=\"https://github.com/cyb3rko\"\u003eCyb3rko\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\u003c/details\u003e\n\n## Used Libraries\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eClick here to see the list\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003ca href=\"https://github.com/cyb3rko/android-licenses-library\"\u003eAndroid Licenses Library\u003c/a\u003e\u003c/td\u003e\n    \u003ctd\u003eby \u003ca href=\"https://github.com/cyb3rko\"\u003eCyb3rKo\u003c/a\u003e\u003c/td\u003e\n    \u003ctd\u003elicensed under \u003ca href=\"https://github.com/cyb3rko/android-licenses-library/blob/master/LICENSE.md\"\u003eApache License 2.0\u003c/a\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n  \u003c/details\u003e\n\n## Used Icons\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eClick here to see the list\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eMultiple Icons made by \u003ca href=\"https://www.flaticon.com/authors/freepik\" title=\"Freepik\"\u003eFreepik\u003c/a\u003e from \u003ca href=\"https://www.flaticon.com/\" title=\"Flaticon\"\u003ewww.flaticon.com\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eMultiple Icons made by \u003ca href=\"https://www.flaticon.com/authors/dave-gandy\" title=\"Dave Gandy\"\u003eDave Gandy\u003c/a\u003e from \u003ca href=\"https://www.flaticon.com/\" title=\"Flaticon\"\u003ewww.flaticon.com\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e  \n\u003c/table\u003e\n\u003c/details\u003e\n\n## License\n\n    Copyright © 2022, Cyb3rKo\n\n    Licensed under the Apache License, Version 2.0 (the \"License\");\n    you may not use this file except in compliance with the License.\n    You may obtain a copy of the License at\n    \n        http://www.apache.org/licenses/LICENSE-2.0\n\n    Unless required by applicable law or agreed to in writing, software\n    distributed under the License is distributed on an \"AS IS\" BASIS,\n    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n    See the License for the specific language governing permissions and\n    limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyb3rko%2Fabout-icons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyb3rko%2Fabout-icons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyb3rko%2Fabout-icons/lists"}