From: j-p Date: Sun, 24 Jul 2016 13:22:39 +0000 (+0200) Subject: Update README.md X-Git-Tag: v0.4~30 X-Git-Url: https://git.osiis.dedyn.io/?a=commitdiff_plain;h=bf43d3ddc4e3f82d9a70060def2eb644a3cea64b;p=jp%2Fcrow.git Update README.md --- diff --git a/README.md b/README.md index 3e92fe20..57245ed2 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,18 @@ -CROW [![NuGet Version and Downloads](https://buildstats.info/nuget/Crow.OpenTK)](https://www.nuget.org/packages/Crow.OpenTK) [![Build Status](https://travis-ci.org/jpbruyere/Crow.svg?branch=master)](https://travis-ci.org/jpbruyere/Crow) [![Build Status Windows](https://ci.appveyor.com/api/projects/status/j387lo59vnov8jbc?svg=true)](https://ci.appveyor.com/project/jpbruyere/Crow) -=========== +#CROW : _C# Rapid Open Widgets._ +[![NuGet Version and Downloads](https://buildstats.info/nuget/Crow.OpenTK)](https://www.nuget.org/packages/Crow.OpenTK) [![Build Status](https://travis-ci.org/jpbruyere/Crow.svg?branch=master)](https://travis-ci.org/jpbruyere/Crow) [![Build Status Windows](https://ci.appveyor.com/api/projects/status/j387lo59vnov8jbc?svg=true)](https://ci.appveyor.com/project/jpbruyere/Crow) **CROW** is a pure **C#** widget toolkit originally developed for easy GUI implementation for [OpenTK](http://opentk.github.io/). -Trying to make it as efficient as possible, it evolved as a full feature toolkit with templates, styles, compositing, and bindings, allowing me to develop new OpenGL apps in a couple of hours. +> Trying to make it as efficient as possible, it evolved as a full feature toolkit with templates, styles, compositing, and bindings, allowing me to develop new OpenGL apps in a couple of hours. Running under Mono, With multi-platform libraries it should run on any target. -Using Crow is an easy way to get instantly some controls into your your OpenGL application. With the binding system, your local -variables are bound to the interface very easily and with the full transparency, your openGL scene will always stay fully visible. +> Using Crow is an easy way to get instantly some controls into your your OpenGL application. With the binding system, your local variables are bound to the interface very easily and with the full transparency, your openGL scene will always stay fully visible. You can visit the [Wiki](https://github.com/jpbruyere/Crow/wiki) or the [Project Site](https://jpbruyere.github.io/Crow/) for documentation and tutorials. _(in progress)_ Please report bugs and issues on [GitHub](https://github.com/jpbruyere/Crow/issues) -Screen shots -============ +####Screen shots : @@ -24,31 +22,25 @@ Screen shots
-Features -======== +####Features : - **XML** interface definition. - Templates and styling - Dynamic binding system with code injection. - Inlined delegates in XML -Requirements -============ - +####Requirements : - **C#6** compatible compiler. -- Mono 4.5 Framework on every os. (It solves the **String Encoding** problem.) -- Cairo Graphic Library >= 1.12 +- Mono >= 4.0 Framework on every os. (It solves the **String Encoding** problem.) +- Cairo Graphic Library >= 1.10 - OpenTK version assume you have OpenGL libraries installed on your system. - GTK Sharp. (At least glib, gio, gdk and cairo cil binding, atk, pango and gtk sharp may be removed from references) -Using CROW in your OpenTK project -================================= +####Using CROW in your OpenTK project : * add [Crow.OpenTK NuGet package](https://www.nuget.org/packages/Crow.OpenTK/) to your project. * Derive **OpenTKGameWindow** class. * Load some widget in the **OnLoad** override with `CrowInterface.LoadInterface` . -Build from sources -================== - +####Build from sources : ``` git clone https://github.com/jpbruyere/Crow.git # Download source code from github cd Crow # Enter the source directory