From: jpbruyere Date: Fri, 14 Apr 2017 08:57:10 +0000 (+0200) Subject: update README X-Git-Tag: v0.9.5-beta~228 X-Git-Url: https://git.osiis.dedyn.io/?a=commitdiff_plain;h=75424623f5a1d65581e6e911d0d00403c8fab814;p=jp%2Fcrow.git update README --- diff --git a/README.md b/README.md index 598c5ed2..db624bc3 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,8 @@ You can visit the [Wiki](https://github.com/jpbruyere/Crow/wiki) or the [Project Please report bugs and issues on [GitHub](https://github.com/jpbruyere/Crow/issues) -###Screen shots : +Screen shots +------------ @@ -24,43 +25,50 @@ Please report bugs and issues on [GitHub](https://github.com/jpbruyere/Crow/issu
-###Features : +Features +-------- + - **XML** interface definition. - Templates and styling - Dynamic binding system with code injection. - Inlined delegates in XML -###Requirements : +Requirements +------------ + - Mono >= 4.0 Framework. - [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 +Installing dependencies +----------------------- -####On Linux +**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: +_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 +**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 : +Build from sources +------------------ ```bash git clone https://github.com/jpbruyere/Crow.git # Download source code from github 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 : +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` .