Browse Source

Update CONTRIBUTING.md

tags/v3.0.5
Xphnx 2 years ago
parent
commit
f41a75867e
1 changed files with 92 additions and 1 deletions
  1. 92
    1
      CONTRIBUTING.md

+ 92
- 1
CONTRIBUTING.md View File

@@ -1 +1,92 @@
1
-I dont have experience with git repos, but I supose it is a good practice to write changes into a new branch and then merge it into master. At this moment opened branch 3.0.2.
1
+#FAQ
2
+#### Is there any template for drawing icons?
3
+- Yes, you have one for each color of the palette. You just have to worry about the design of the logo and its proportions. Take a look at the [wiki](https://gitlab.com/xphnx/twelf_cm12_theme/wikis/home)
4
+
5
+
6
+#### Is there any guidelines to follow drawing the icons?
7
+- It is convenient to visit the [Google Material Design website](http://www.google.com/design/spec/style/icons.html). The templates include most of the items, so you will not have to worry about them, but this site provides  much interesting information you should follow when designing.
8
+
9
+
10
+#### The update don't aply the new icons
11
+- Probably a CM13 bug (?). You can solve it applying the stock icon pack and then applying again Ameixa.
12
+
13
+
14
+#### I had a themed icon, but a recent update of the app reverts it to the original one
15
+- Probably the upstream changes the activity name into androidmanifest.xml. You can compare the activityname using [Turtl](https://f-droid.org/repository/browse/?fdid=org.xphnx.iconsubmit) with the code of [appfilter](). If the activityname have changed in fact, then you can try to do a MR with a [patch](https://gitlab.com/xphnx/twelf_cm12_theme/wikis/home#add-activities-to-appfilterxml), or request for a fix trough [Issue tracker](https://gitlab.com/xphnx/twelf_cm12_theme/issues)
16
+
17
+
18
+#### An app crashes when attempts to create a notification icon with the theme applied.
19
+- This must be fixed on the upstream adding a proper (smaller, all-white) notification icon [setSmallIcon](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.Builder.html#setSmallIcon%28int%29). Is possible that for Android 4 (CM11) can be added another colored icon ([SetLargeIcon](https://developer.android.com/reference/android/support/v4/app/NotificationCompat.Builder.html#setLargeIcon%28android.graphics.Bitmap%29)) to be shown in the ticker and notification.
20
+
21
+
22
+- Please contact the upstream and report the bug. You can provide them  more information referring to these links, in which some apps have already fixed this problem. And If you can, report relevant information [here](https://gitlab.com/xphnx/twelf_cm12_theme/issues/66) for completing the documentation about this problem.:
23
+     - [SetLargeIcon applied by Mirakel](https://github.com/MirakelX/mirakel-android/blob/master/model/src/de/azapps/mirakel/services/NotificationService.java#L131)
24
+     - [Fix1 applied by Osmand](https://github.com/osmandapp/Osmand/commit/467da92d3e6f139bd113e4500f1b801567e8c89e)
25
+     - [Fix2 applied by Osmand](https://github.com/osmandapp/Osmand/commit/096f0c2bc1c29e8a0ec95e7d763aec6460cbec2d)
26
+     - [Fix applied by ownCloud-SMS](https://github.com/nerzhul/ownCloud-SMS-App/commit/1483b9d51607f1837ac27460cbf506b0b98c6562)
27
+     - [Fix applied by Syncthing](https://github.com/syncthing/syncthing-android/pull/332/files)
28
+
29
+
30
+#### I see the icon of an app in [its folders](https://gitlab.com/xphnx/twelf_cm12_theme/tree/master/theme/src/main/assets/icons/res) but it's not working in the theme
31
+- Probably there is an error into the [appfilter.xml](https://gitlab.com/xphnx/twelf_cm12_theme/blob/master/theme/src/main/assets/icons/res/xml/appfilter.xml).
32
+     1. Look if ```drawable="iconname" />``` match the icon name of the png into the folders
33
+     2. Look if the [activity name](https://gitlab.com/xphnx/twelf_cm12_theme/wikis/home#add-activities-to-appfilterxml) is right (You can use Turtl). 
34
+     3. Feel free to open a MR with a patch or [request a fix](https://gitlab.com/xphnx/twelf_cm12_theme/issues)
35
+
36
+
37
+#### How can I build the app by myself?
38
+-  You have this options:
39
+     1. Gitlab Continous Integration.  The file .gitlab-ci.yml is included yet, enable a shared runner, download the output from Builds. [Gitlab CI Quick Start](http://docs.gitlab.com/ce/ci/quick_start/README.html) (Unsigned apk)
40
+     2. Android Studio (GUI. Builds and signs) [Official download](https://developer.android.com/sdk/index.html) / [PPA by Paolo Rotolo](https://paolorotolo.github.io/android-studio/) (works on Debian/Ubuntu and derivatives). 
41
+     3. Graddle (command line and gui [Official userguide](https://docs.gradle.org/current/userguide/userguide.html)
42
+     4. The Graddle wrapper (scritps, Gradle will be automatically downloaded and used to run the build) [Gradle wrapper userguide](https://docs.gradle.org/current/userguide/gradle_wrapper.html) (Gitlab CI uses this)
43
+     4. Fdroid server [Official manual](https://f-droid.org/manual/fdroid.html)
44
+
45
+
46
+# How to add an icon
47
+**Steps**: 
48
+1. Draw a white icon on its layer of the [**SVG template**](https://gitlab.com/xphnx/twelf_cm12_theme/tree/master/svgs/svg_templates_twelf), 
49
+2. Put your svg icon into the [**SVG wip folder**](https://gitlab.com/xphnx/twelf_cm12_theme/tree/master/svgs/wip), 
50
+3. Add the activity of the app to [appfilter.xml](https://gitlab.com/xphnx/twelf_cm12_theme/blob/master/theme/src/main/assets/icons/res/xml/appfilter.xml) and add the icon's license to the [LICENSE](https://gitlab.com/xphnx/twelf_cm12_theme/blob/master/LICENSE.md) file.
51
+4. (Optional) Run the script proccess_wipsvg.sh. (It generates the proper pngs and move the svg from wip to depot folder.)
52
+
53
+**Breaf instructions**: A template file contains three layers (to see them, select Layer - Layers from the menu; to toggle layer visibility, use the eye-like icons near the layer names). The bottom layer contains the background of the icon. It has proper color, shadow, shade and tint. Do not modify those.
54
+
55
+The top layer (hints) shows the keyline shapes, the regions that define the size of your icon. In short, a mostly square icon must fit into a square one (black lines). A horizontal rectangle, in the horizontal rectangle (blue lines). A vertical rectangle icon, into the vertical rectangle (green lines) and the mostly round one should mostly fit in the larger square-without-the-corners that they form. Most part of your icon should fit into one or several of those rectangles. Note that small items can extend beyond this area. For more information on this, please refer to the section ["Proportions"](https://gitlab.com/xphnx/twelf_cm12_theme/wikis/home#proportions) below and to the [Google's guide](http://www.google.com/design/spec/style/icons.html#icons-system-icons).
56
+
57
+The icon layer is the most interesting one. This is the layer you should draw your icon on. It already contains an indication, please delete it and draw the desired logo in white (#ffffffff) instead of it.
58
+
59
+### Add Activities to appfilter.xml
60
+
61
+
62
+You can use [Turtle](https://f-droid.org/repository/browse/?fdid=org.xphnx.iconsubmit) to obtain the code. Note Turtl sets the iconname as a string (related to the activityname). You have to change the string inside: ``` drawable="xxxxxxxxxx" />``` and make sure it is identical to the .svg you put into the svgs/wip folder.
63
+
64
+### Proportions
65
+
66
+![style_logos_product_grid_shapes_vert_rectangle](https://gitlab.com/xphnx/twelf_cm12_theme/uploads/04e86f2f60dd3b29b9c013af40465b8a/style_logos_product_grid_shapes_vert_rectangle.png)![style_logos_product_grid_shapes_hori_rectangle](https://gitlab.com/xphnx/twelf_cm12_theme/uploads/0755668fec705d1446ee30e82b02db36/style_logos_product_grid_shapes_hori_rectangle.png)![style_logos_product_grid_shapes_square](https://gitlab.com/xphnx/twelf_cm12_theme/uploads/8f763839988c14c083d336841ab13d34/style_logos_product_grid_shapes_square.png)![style_logos_product_grid_shapes_circle](https://gitlab.com/xphnx/twelf_cm12_theme/uploads/f4acad231a240b1122684f127c87584f/style_logos_product_grid_shapes_circle.png)
67
+
68
+### Resolutions
69
+
70
+|RESOLUTION| PX      | DPI |
71
+| :-----: |:-------:| :---:|
72
+| MDPI    | 48x48   | 120 |
73
+| HDPI    | 72x72   | 240 |
74
+| XHDPI   | 96x96   | 320 |
75
+| XXHDPI  | 144x144 | 480 |
76
+| XXXHDPI | 192x192 | 640 |
77
+
78
+## More info 
79
+**Please read this carefully for a deeper understanding:**
80
+
81
+* [Colors material design](http://www.google.com/design/spec/style/color.html) 
82
+
83
+* [Material Design Product Icons](http://www.google.com/design/spec/style/icons.html#icons-product-icons)
84
+
85
+* [Material Design System Icons](http://www.google.com/design/spec/style/icons.html#icons-system-icons)
86
+
87
+### Add Material Color Palette to Inkscape
88
+
89
+[Material Design Color Palette for Inkscape] (https://github.com/MaTriXy/Material-Design-Color-Palette-for-Inkscape)
90
+
91
+# Creating a Boot Animation
92
+[See this link](https://github.com/cyngn/android_packages_themes_Template#special-creating-a-boot-animation)

Loading…
Cancel
Save