]> O.S.I.I.S - jp/crow.git/commitdiff
Update README.md
authorj-p <jp.bruyere@live.be>
Sun, 13 Aug 2017 07:30:50 +0000 (09:30 +0200)
committerGitHub <noreply@github.com>
Sun, 13 Aug 2017 07:30:50 +0000 (09:30 +0200)
README.md

index db624bc31c528fe0fbe0a53480c643d006f2de84..b825569c20ead64e1e5fa8d8a9d2af25f0decbdc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,20 @@
-#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)
+# C# Rapid Open Widgets
+[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/GrandTetraSoftware)[![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/).
-
-Crow is in early developement state, I'm working on a first beta (0.5).
-
-> 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.
+**CROW** is a pure **C#** widget toolkit originally developed for fast GUI implementation in [OpenTK](http://opentk.github.io/) applications.
 
 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)
 
+Features
+--------
+
+- **XML** interface definition.
+- Templates and styling
+- Dynamic binding system with code injection.
+- Inlined delegates in XML
+
 Screen shots
 ------------
 
@@ -25,41 +26,13 @@ Screen shots
   </tr>
 </table>
 
-Features
---------
-
-- **XML** interface definition.
-- Templates and styling
-- Dynamic binding system with code injection.
-- Inlined delegates in XML
-
 Requirements
 ------------
 
-- Mono >= 4.0 Framework. 
+- c# compiler
 - [Cairo Graphic Library](https://cairographics.org/) >= 1.10 
-- [OpenTK](http://opentk.github.io/).
-- glib, gio, and gdk >= 3.0. (part of GTK project).
-
-Installing dependencies
------------------------
 
-**On Linux**
-For **mono**, You may install **mono-complete**, or only **xbuild**, **mono runtime** and minimal system **CIL** libs (system, xml, drawing)
-```bash
-sudo apt-get install mono-complete libcairo1.10-cil libgio3.0-cil libgdk3.0-cil libglib3.0-cil
-```
-_Or:_
-```bash
-sudo apt-get install -y xbuild mono-runtime libmono-system-core4.0-cil libmono-system-xml4.0-cil libmono-system-drawing4.0-cil libcairo1.10-cil libgio3.0-cil libgdk3.0-cil libglib3.0-cil
-```
-**On Windows**
-- Install [Mono and GTK#](http://www.mono-project.com/download/#download-win)
-- Add **CIL dll's** path to your environment **PATH** variable, and also **native dll's** path of cairo and gtk.
-
-    `set path=%path%;C:\Program Files (x86)\Mono\bin`
-
-Build from sources
+Building
 ------------------
 ```bash
 git clone https://github.com/jpbruyere/Crow.git        # Download source code from github
@@ -67,10 +40,11 @@ cd Crow                                                     # Enter the source directory
 nuget restore Crow.sln                                                         # Restore nuget packages
 xbuild  /p:Configuration=Release Crow.sln                      # Build with Mono 
 ```
+
 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` .
+* Derive **CrowWindow** class.
+* Load some widget in the **OnLoad** override with `CrowWindow.Load` .
 * Build your project with **mono**. (**xbuild**)
 - copy **Crow.dll.config** to output directory if you have trouble finding native libs.