]> O.S.I.I.S - jp/crow.git/commitdiff
update README
authorjpbruyere <jp.bruyere@hotmail.com>
Fri, 14 Apr 2017 08:57:10 +0000 (10:57 +0200)
committerjpbruyere <jp.bruyere@hotmail.com>
Fri, 14 Apr 2017 08:57:10 +0000 (10:57 +0200)
README.md

index 598c5ed203f9cde8ab06c49ff12141c919061f12..db624bc31c528fe0fbe0a53480c643d006f2de84 100644 (file)
--- 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
+------------
 
 <table width="100%">
   <tr>
@@ -24,43 +25,50 @@ Please report bugs and issues on [GitHub](https://github.com/jpbruyere/Crow/issu
   </tr>
 </table>
 
-###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` .