diff options
| author | Jean-Philippe Bruyère <jp_bruyere@hotmail.com> | 2018-01-31 14:27:38 +0100 |
|---|---|---|
| committer | Jean-Philippe Bruyère <jp_bruyere@hotmail.com> | 2018-01-31 14:57:11 +0100 |
| commit | e3a586148d084b7eea974bae4fa00a19fc547c28 (patch) | |
| tree | 8b79dc07b700047b7bf541a8770ac40ec94f569d /README.md | |
| parent | eed1c7a49ada2b8146083b14ad2b568d503291af (diff) | |
:memo:
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 87 |
1 files changed, 50 insertions, 37 deletions
@@ -1,48 +1,61 @@ -# C# Rapid Open Widgets -[](https://www.paypal.me/GrandTetraSoftware) [](https://www.nuget.org/packages/Crow.OpenTK) [](https://travis-ci.org/jpbruyere/Crow) [](https://ci.appveyor.com/project/jpbruyere/Crow) +<h1 align="center"> + <br> + <a href="http://www.amitmerchant.com/electron-markdownify"> + <img src="https://github.com/jpbruyere/Crow/blob/master/Images/Icons/crow.png" alt="C.R.O.W." width="140"> + </a> + <br> + <br> + C# Rapid Open Widgets + <br> +<p align="center"> + <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> + <a href="https://ci.appveyor.com/project/jpbruyere/Crow"> + <img src="https://ci.appveyor.com/api/projects/status/j387lo59vnov8jbc?svg=true"> + </a> +</p> +</h1> -**CROW** is a pure **C#** widget toolkit originally developed for fast GUI implementation in [OpenTK](http://opentk.github.io/) applications. +**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> +</p> -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)_ +You can visit the [Wiki](https://github.com/jpbruyere/Crow/wiki) or the [Project Site](https://jpbruyere.github.io/Crow/) +for documentation and tutorials. 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 ------------- - -<table width="100%"> - <tr> - <td width="30%" align="center"><img src="https://jpbruyere.github.io/Crow/images/screenshot5.png" alt="CrowIDE" width="90%"/></td> - <td width="30%" align="center"><img src="https://jpbruyere.github.io/Crow/images/screenshot4.png" alt="Screen Shot" width="90%" /> </td> - <td width="30%" align="center"><img src="https://jpbruyere.github.io/Crow/images/screenshot3.png" alt="Screen Shot" width="90%"/> </td> - </tr> -</table> - -Requirements ------------- - -- c# compiler +## Getting Start +### Requirements +- [mono > 4.5](http://www.mono-project.com/) - [Cairo Graphic Library](https://cairographics.org/) >= 1.10 - -Building ------------------- +- [rsvg library](https://developer.gnome.org/rsvg/) for svg rendering +- [nuget](https://www.nuget.org/). +### Building from source +_[Git](https://git-scm.com) has to be installed._ ```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 +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 nuget * add [Crow.OpenTK NuGet package](https://www.nuget.org/packages/Crow.OpenTK/) to your project. * Derive **CrowWindow** class. * Load some widget in the **OnLoad** override with `CrowWindow.Load` . |