update README

diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644 (file)
index 0000000..d65cd06
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2018] [Jean-Philippe Bruyère]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

diff --git a/README.md b/README.md
index 4945d747e8f71248036f14cda80caf81dc15d3f6..04e3998ea1560dbf4b87b1bace09138a5b9f19e0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,36 @@
-# vkvg
+<h1 align="center">
+  <br>
+  <a href="https://github.com/jpbruyere/vkvg/blob/master/vkvg.svg">
+    <img src="https://github.com/jpbruyere/vkvg/blob/master/vkvg.svg?sanitize=true" alt="vkvg" width="140">
+  </a>
+  <br>  
+    <br>
+  Vulkan Vector Graphics
+  <br>  
+<p align="center">
+  <a href="https://www.paypal.me/GrandTetraSoftware">
+    <img src="https://img.shields.io/badge/Donate-PayPal-green.svg">
+  </a>
+</p>
+</h1>
+
+### What is vkvg?
+
+**vkvg** is a multiplateform **c** library for drawing 2d vector graphics with [Vulkan](https://www.khronos.org/vulkan/).
+
+[Cairo](https://www.cairographics.org/) missing a vulkan backend, I decided to start one myself trying to keep my api as close to cairo as possible. Maybe vkvg could serve as a starting point for cairo maintainers to start their vulkan backend.
+
+### Current status: 
+
+vkvg is in early development stage, and no guarantie is given on the possible roadmap.
+
+- Basic shape fill and stroke functional, using ears clipping.
+- Basic painting operation.
+- Font system with caching operational.
+- Context should be thread safe, tests required.
+- Nice logo.
+
+### Roardmap
+
+- Offscreen pattern building. 
+

diff --git a/vkvg.svg b/vkvg.svg
new file mode 100644 (file)
index 0000000..df4f790
--- /dev/null
+++ b/vkvg.svg
@@ -0,0 +1,120 @@
+<?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:xlink="http://www.w3.org/1999/xlink"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="102.07465"
+   height="71.185143"
+   viewBox="0 0 27.007252 18.834403"
+   version="1.1"
+   id="svg852"
+   inkscape:version="0.92.2 (5c3e80d, 2017-08-06)"
+   sodipodi:docname="vkvg.svg"
+   inkscape:export-filename="/mnt/devel/gts/vkvg/logo.png"
+   inkscape:export-xdpi="90"
+   inkscape:export-ydpi="90">
+  <defs
+     id="defs846">
+    <linearGradient
+       inkscape:collect="always"
+       id="linearGradient845">
+      <stop
+         style="stop-color:#2d8dad;stop-opacity:1"
+         offset="0"
+         id="stop841" />
+      <stop
+         style="stop-color:#83deff;stop-opacity:0"
+         offset="1"
+         id="stop843" />
+    </linearGradient>
+    <linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient845"
+       id="linearGradient847"
+       x1="110.68917"
+       y1="31.07439"
+       x2="91.910088"
+       y2="2.6321857"
+       gradientUnits="userSpaceOnUse" />
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="2.0000001"
+     inkscape:cx="55.543792"
+     inkscape:cy="-18.195561"
+     inkscape:document-units="mm"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     inkscape:window-width="1600"
+     inkscape:window-height="881"
+     inkscape:window-x="0"
+     inkscape:window-y="0"
+     inkscape:window-maximized="1"
+     units="px"
+     fit-margin-top="2"
+     fit-margin-left="2"
+     fit-margin-right="2"
+     fit-margin-bottom="2">
+    <inkscape:grid
+       type="xygrid"
+       id="grid1397"
+       originx="-8.7505678"
+       originy="-329.84273" />
+  </sodipodi:namedview>
+  <metadata
+     id="metadata849">
+    <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(-36.983507,-7.4244837)">
+    <g
+       id="g854"
+       inkscape:export-xdpi="90.02018"
+       inkscape:export-ydpi="90.02018"
+       inkscape:export-filename="logo.png">
+      <path
+         sodipodi:nodetypes="ccccccc"
+         inkscape:connector-curvature="0"
+         id="path838"
+         d="M 124.35416,29.770833 99.054233,36.549929 80.5334,18.029095 89.823048,2.0986798 l 25.299922,-6.779096 16.01029,9.1513207 z"
+         inkscape:transform-center-x="2.1421585e-06"
+         style="opacity:1;fill:url(#linearGradient847);fill-opacity:1;stroke:#7d7d7d;stroke-width:0.53889078;stroke-linecap:butt;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;paint-order:normal"
+         transform="matrix(0.47424803,0.12707438,-0.12707438,0.47424803,1.7254712,-4.3235598)" />
+      <path
+         id="path849"
+         style="fill:none;stroke:#848484;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         d="m 46.493561,17.443984 v 6.614583 m 0.79151,-7.493167 c 0,0.437128 -0.35436,0.791491 -0.79149,0.791491 -0.43713,0 -0.7915,-0.354363 -0.7915,-0.791491 0,-0.437128 0.35437,-0.791491 0.7915,-0.791491 0.43713,0 0.79149,0.354363 0.79149,0.791491 z m -0.79149,-3.35475 -2e-5,2.55625 m 10.58341,3.000001 h 2.64585 l -2.64585,5.291666 -2.64585,-5.291666 m 2.64585,-5.291668 -5.29169,10.583334 -3.17504,-6.35 m 3.17504,-4.233334 c -5.29172,5.291667 -5.2917,10.583334 -5.2917,10.583334 m -5.2917,-10.583334 c 5.29168,5.291667 5.2917,10.583334 5.2917,10.583334"
+         inkscape:connector-curvature="0"
+         sodipodi:nodetypes="ccsssssccccccccccccc" />
+      <path
+         sodipodi:nodetypes="ccsssssccccccccccccc"
+         inkscape:connector-curvature="0"
+         d="M 45.964394,16.914817 V 23.5294 m 0.79151,-7.493167 c 0,0.437128 -0.35436,0.791491 -0.79149,0.791491 -0.43713,0 -0.7915,-0.354363 -0.7915,-0.791491 0,-0.437128 0.35437,-0.791491 0.7915,-0.791491 0.43713,0 0.79149,0.354363 0.79149,0.791491 z m -0.79149,-3.35475 -2e-5,2.55625 m 10.58341,3.000001 h 2.64585 l -2.64585,5.291666 -2.64585,-5.291666 m 2.64585,-5.291668 -5.29169,10.583334 -3.17504,-6.35 m 3.17504,-4.233334 c -5.29172,5.291667 -5.2917,10.583334 -5.2917,10.583334 m -5.2917,-10.583334 c 5.29168,5.291667 5.2917,10.583334 5.2917,10.583334"
+         style="fill:none;stroke:#ffffff;stroke-width:0.5291667;stroke-linecap:butt;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         id="path836" />
+    </g>
+  </g>
+</svg>