From cf93176c9b76b577c1ccaf5418ed62d529819ed9 Mon Sep 17 00:00:00 2001
From: Xphnx <xphnx@tutanota.com>
Date: Fri, 12 Jan 2018 13:10:35 +0000
Subject: [PATCH] Update README.md

---
 README.md | 38 +++++++++++++++++++++++++++-----------
 1 file changed, 27 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index e05082854..ddf18e97f 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,34 @@
 ![CI bagde](https://gitlab.com/xphnx/ameixa/badges/master/build.svg)
 
-Icon pack compatible with Trebuchet, Kiss Launcher , OpenLauncher, Adw and many more launchers. A Material Design inspired theme aiming to provide a consistent and minimalistic look to your device. Code forked from [Icecons icon pack](https://github.com/1C3/ICEcons).
+Icon pack compatible with Trebuchet, Kiss Launcher , OpenLauncher, Adw and many more launchers. A Material Design inspired theme aiming to provide a consistent and minimalistic look to your device. Code forked from [Icecons icon pack](https://github.com/1C3/ICEcons). Only [F-droid](https://f-droid.org/) hosted apps are supported.
 
-Only [F-droid](https://f-droid.org/) hosted apps are supported.
 
-##### [Changelog](https://gitlab.com/xphnx/ameixa/blob/master/CHANGELOG.md)
+# Contributions are welcome 
 
+For requesting icons or contributing, please use the [Issue Tracker](https://gitlab.com/xphnx/ameixa/issues) or [Merge Requests](https://gitlab.com/xphnx/ameixa/merge_requests)
 
-## Installation
+#### What happens?
+  
+* [ ] The activityname line is in [appfilter](https://gitlab.com/xphnx/ameixa/blob/master/app/src/main/res/xml/appfilter.xml)
+* [ ] The activityname has changed or is not in [appfilter](https://gitlab.com/xphnx/ameixa/blob/master/app/src/main/res/xml/appfilter.xml) --> Use [Turtl](https://f-droid.org/packages/org.xphnx.iconsubmit/) to find out the Activityname line to be include in appfilter.xml
 
-[![Get_it_on_F-Droid.svg](https://gitlab.com/uploads/xphnx/twelf_cm12_theme/a4649863bd/Get_it_on_F-Droid.svg.png)](https://f-droid.org/app/org.xphnx.ameixa)
- 
-[![Get_the_apk.svg](https://gitlab.com/xphnx/ameixa/uploads/6d80e2e22d2fcbfd8ed320e58f4705e1/apk.png)](https://gitlab.com/xphnx/ameixa/-/jobs/47531260/artifacts/browse/app/build/outputs/apk/)
+</br>
+* [ ] The icon is in [icons folder](https://gitlab.com/xphnx/ameixa/tree/master/icons)
+* [ ] The icon is in [todo/wip folder](https://gitlab.com/xphnx/ameixa/tree/master/todo/wip)
+* [ ] There is not the proper icon in todo/wip or icons --> Grab a [template](https://gitlab.com/xphnx/ameixa/tree/master/templates) and draw a new icon. (More [info](https://gitlab.com/xphnx/twelf_cm12_theme/wikis/home))
 
+</br>
+* [ ] The icon file name and the drawable string into activityname line doesn't match --> Fix activityname
 
-## Contributions are welcome 
 
-Templates included into the svgs folder. For requesting icons or contributing, please use the [issue tracker](https://gitlab.com/xphnx/ameixa/issues)
+#### What to do?  (You have 4 options:)
 
-## Screenshots
+1. Write a new activityname in [Issue Tracker](https://gitlab.com/xphnx/ameixa/issues)
+2. Atach the new icon (.svg) in [Issue Tracker](https://gitlab.com/xphnx/ameixa/issues)
+3. [MR](https://gitlab.com/xphnx/ameixa/merge_requests) activityname lines into appfilter.xml and/or icon files (.svg) into todo/wip
+4. [MR](https://gitlab.com/xphnx/ameixa/merge_requests) activityname and/or icon data (.pngs and xml) after running the script [process_wipsvg.sh](https://gitlab.com/xphnx/ameixa/blob/master/process_wipsvg.sh)
+
+# Screenshots
 
 ![screenshot1-thumb](/uploads/c1b689614b683cff658c3d8245ef6cea/screenshot1-thumb.jpg)
 ![screenshot2-thumb](/uploads/833855214502447743662f1e010db19e/screenshot2-thumb.jpg)
@@ -36,7 +46,13 @@ Templates included into the svgs folder. For requesting icons or contributing, p
 <img src="https://gitlab.com/xphnx/twelf_cm12_theme/uploads/a49b1be4708a70c2e3c554342ba21edb/Screenshot_2015-05-22-23-55-18.png" alt="inside afw++" width="300" />
 -->
 
-## License
+# Installation
+
+[![Get_it_on_F-Droid.svg](https://gitlab.com/uploads/xphnx/twelf_cm12_theme/a4649863bd/Get_it_on_F-Droid.svg.png)](https://f-droid.org/app/org.xphnx.ameixa)
+[![Get_the_apk.svg](https://gitlab.com/xphnx/ameixa/uploads/6d80e2e22d2fcbfd8ed320e58f4705e1/apk.png)](https://gitlab.com/xphnx/ameixa/-/jobs/47531260/artifacts/browse/app/build/outputs/apk/)
+
+
+# License
 
 <img src="https://gnu.org/graphics/gplv3-127x51.png" />
 
-- 
GitLab