Commit d70876c4 authored by MANCIAUX romain's avatar MANCIAUX romain
Browse files

feat(08-icon-style): add a documentation to create icon

parent 6acc2eb3
......@@ -12,4 +12,5 @@ Coding style
src/05-xml-style
src/06-cmake-style
src/07-glsl-style
src/08-license
src/08-icon-style
src/09-license
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="130mm"
height="130mm"
viewBox="0 0 130 130"
version="1.1"
id="svg8476"
inkscape:version="0.92.3 (2405546, 2018-03-11)"
sodipodi:docname="icon.svg">
<defs
id="defs8470" />
<sodipodi:namedview
id="base"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="0.7"
inkscape:cx="-334.0409"
inkscape:cy="351.8817"
inkscape:document-units="mm"
inkscape:current-layer="layer1"
showgrid="false"
inkscape:window-width="1920"
inkscape:window-height="1137"
inkscape:window-x="-8"
inkscape:window-y="-8"
inkscape:window-maximized="1" />
<metadata
id="metadata8473">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:label="Calque 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(0,-167)">
<rect
style="fill:none;fill-opacity:1;stroke:#f6ae5a;stroke-width:0.76008856;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
id="rect9021"
width="99.239906"
height="99.239914"
x="15.380044"
y="182.38005"
ry="3.0487139" />
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
x="47.57729"
y="178.85611"
id="text9039"><tspan
sodipodi:role="line"
x="47.57729"
y="178.85611"
style="stroke-width:0.26458332"
id="tspan9041">W:130</tspan></text>
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
x="208.38251"
y="-118.30573"
id="text9039-6"
transform="rotate(89.940327)"><tspan
sodipodi:role="line"
x="208.38251"
y="-118.30573"
style="stroke-width:0.26458332"
id="tspan9041-9">H:130</tspan></text>
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
x="24.60391"
y="191.58078"
id="text9039-0"><tspan
sodipodi:role="line"
x="24.60391"
y="191.58078"
style="stroke-width:0.26458332"
id="tspan9041-95">Internal W:100</tspan></text>
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
x="192.41006"
y="-105.46288"
id="text9039-0-1"
transform="rotate(90.112482)"><tspan
sodipodi:role="line"
x="192.41006"
y="-105.46288"
style="stroke-width:0.26458332"
id="tspan9041-95-3">Internal H:100</tspan></text>
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:10.58333302px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
x="204.8983"
y="-4.2075863"
id="text9091"
transform="rotate(90)"><tspan
sodipodi:role="line"
id="tspan9089"
x="204.8983"
y="-4.2075863"
style="stroke-width:0.26458332">Border:15</tspan></text>
<rect
style="fill:none;fill-opacity:1;stroke:#2d2d2d;stroke-width:1.96969688;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
id="rect824"
width="128.0303"
height="128.0303"
x="0.98484802"
y="167.98485" />
</g>
</svg>
Glsl coding
GLSL coding
============
Source and files
......
Icon style
==========
Files
-----
.. rule :: Files extensions
Icon files use the extension ``.svg``.
Drawing conventions
-------------------
.. rule :: Color
We recommend to use the following colors (this list is not exhaustive):
- Light green : rgb(165,194,92)
- Green: rgb(97,150,71)
- Red : rgb(210,82,82)
- Purple : rgb(152,118,170)
- Orange : rgb(203,119,47)
- Yellow : rgb(255,198,109)
- Light blue : rgb(190,214,255)
- Dark blue : rgb(33,66,131)
- Light gray : rgb(169,183,198)
- Gray : rgb(128,128,128)
- Dark gray : rgb(90,90,90)
.. rule :: File name
The file name must start with the the color of the icon (if there is one), followed by the type of the icon, the name must be in UpperCamelCase.
.. rule :: Frame
To have a set of icons with a sufficient size to be seen, the size of the main frame must be 130px * 130px. You also must respect a drawing area of 100px* 100px inside the main frame in order to don't fill the area and create sweet icons. Which means that the internal border must be 15px* 15px.
.. image:: ../media/icon.svg
:height: 300 px
:width: 300 px
:align: center
.. rule :: Shape
If the shape has a border, it must be 2px thick and have the same color as the shape, with a brightness divided by two.
.. note :: Exemples
.. image:: ../media/exemples.png
:align: right
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment