From: j-p <jp_bruyere@hotmail.com>
Date: Sun, 4 Aug 2019 13:04:46 +0000 (+0200)
Subject: update readme (#48)
X-Git-Tag: v0.9.5-beta~137^2~20
X-Git-Url: https://git.osiis.dedyn.io/?a=commitdiff_plain;h=f911c166a584ba9e56fd1e7c7c619af7f0e204c1;p=jp%2Fcrow.git

update readme (#48)
---

diff --git a/Images/screenshot3.png b/Images/screenshot3.png
new file mode 100644
index 00000000..044d991f
Binary files /dev/null and b/Images/screenshot3.png differ
diff --git a/README.md b/README.md
index cf0c8cc2..c85937dc 100644
--- a/README.md
+++ b/README.md
@@ -14,9 +14,6 @@
   <a href="https://www.paypal.me/GrandTetraSoftware">
     <img src="https://img.shields.io/badge/Donate-PayPal-green.svg">
   </a>
-  <a href="https://www.nuget.org/packages/Crow.OpenTK">
-    <img src="https://buildstats.info/nuget/Crow.OpenTK">
-  </a>
   <a href="https://travis-ci.org/jpbruyere/Crow">
       <img src="https://travis-ci.org/jpbruyere/Crow.svg?branch=master">
   </a>
@@ -25,15 +22,17 @@
   </a>
 </p>
 </h1>
+**C.R.O.W.** is an  [application framework](https://en.wikipedia.org/wiki/Application_framework) for building portable graphical interfaces entirely developed in **C#**. It provides a declarative interface language with **styling** and **templates** called [IML](interface-markup-language) for **Interface Markup Language** similar to [XAML](https://en.wikipedia.org/wiki/Extensible_Application_Markup_Language) and a binding system for easy code linking.
 
-## Presentation
-**C.R.O.W.** is a [widget toolkit](https://en.wikipedia.org/wiki/Widget_toolkit) and rendering engine entirely developed in **C#**, offering a nice trade-off between complexity of language and performances. Crow provides a declarative interface language with styling and templates called [IML](interface-markup-language) for **Interface Markup Language** similar to [XAML](https://en.wikipedia.org/wiki/Extensible_Application_Markup_Language) and a binding system for easy c# code linking.
-<p align="center">
-  <a href="https://github.com/jpbruyere/Crow/blob/master/Images/screenshot.png">
-    <img src="https://github.com/jpbruyere/Crow/blob/master/Images/screenshot.png" width="400">
-  </a>
-  <br>(CrowIde is not realy functional for now, it serves me to test limits and perf of templated interfaces)
-</p>
+C.R.O.W. is in **beta** development state, api could change.
+
+There's currently **3 main versions**, diverging on the way they handle OS integration. The last one replace [Cairo](https://www.cairographics.org/) with [vkvg](https://github.com/jpbruyere/vkvg).
+
+| Package         | Description      | Link                             |
+|-------------------|--------------------|------------------------------|
+| Crow.OpenTK |OS layer handle with [OpenTK](https://github.com/opentk/opentk), fast implementation of 3D gui in OTK scenes |[![nuget](https://buildstats.info/nuget/Crow.OpenTK?includePreReleases=true&vWidth=100)](https://www.nuget.org/packages/Crow.OpenTK)    |
+| Crow               | `IBackend` interface for **xcb** and **win32** |[![nuget](https://buildstats.info/nuget/Crow?includePreReleases=true&vWidth=100)](https://www.nuget.org/packages/Crow)     |
+| Crow.Vk          | OS layer with [GLFW](https://www.glfw.org/), [vkvg](https://github.com/jpbruyere/vkvg) for accelerated 2d vectors and text.| [![nuget](https://buildstats.info/nuget/Crow.VK?includePreReleases=true&vWidth=100)](https://www.nuget.org/packages/Crow.Vk)     |
 
 #### Features
 - [Declarative interface definition](https://github.com/jpbruyere/Crow/wiki/interface-markup-language).
@@ -42,26 +41,28 @@
 - [Dynamic binding system](https://github.com/jpbruyere/Crow/wiki/The-binding-system)
 - SVG rendering (with [rsvg library](https://developer.gnome.org/rsvg/))
 
-#### Status
+<p align="center">
+  <a href="https://github.com/jpbruyere/Crow/blob/master/Images/screenshot.png">
+	<kbd><img src="https://github.com/jpbruyere/Crow/blob/master/Images/screenshot.png" height="200"></kbd>
+  </a>
+  <a href="https://github.com/jpbruyere/Crow/blob/master/Images/screenshot3.png">
+	<kbd><img src="https://github.com/jpbruyere/Crow/blob/master/Images/screenshot3.png" height="200"></kbd>
+  </a>
+  <a href="https://raw.githubusercontent.com/wiki/jpbruyere/Crow/images/chess.jpg">
+	<kbd><img src="https://raw.githubusercontent.com/wiki/jpbruyere/Crow/images/chess.jpg" height="200"></kbd>
+  </a>
+</p>
 
-**C.R.O.W.** is in beta development state, api could change.
+#### Documentation
 
-I've tested three pathes for further developments:
-* OpenTk integration, initial architecture. Nuget package = Crow.OpentTK
-* Stand Alone Crow with no OS integration, Nuget has version 8.* under the name Crow.
-* Vulkan backend (vk.net) with VKVG as a replacement for cairo and GLFW for OS integration, this last path is the closest to what I want to make with CROW. Maybe I'll try to keep Cairo as an option for backend. The nuget packge is Crow.VK and the source three is in the branch vknet. Due to the early state of VKVG, this should be considered as an early preview.
+Due to the early state of this project and the frequent changes, some part of the docs may be outdated.
 
-#### Documentation
 * [Introduction](https://github.com/jpbruyere/Crow/wiki)
 * [Classes documentation autogenerated from doxygen](https://github.com/jpbruyere/Crow/wiki/index)
 * [Tutorials](https://github.com/jpbruyere/Crow/wiki/Tutorials)
 
 Please report bugs and issues on [GitHub](https://github.com/jpbruyere/Crow/issues)
 
--------------------
-
-## Getting Start
-
 ### Requirements
 - [Cairo Graphic Library](https://cairographics.org/) >= 1.20 
 - [rsvg library](https://developer.gnome.org/rsvg/) for svg rendering