aboutsummaryrefslogtreecommitdiffstatsci
diff options
context:
space:
mode:
authorjpbruyere <jp.bruyere@hotmail.com>2016-08-04 22:23:13 +0200
committerjpbruyere <jp.bruyere@hotmail.com>2016-08-04 22:23:13 +0200
commit808e85be1d60eccc869dfe6c136a525d465352f0 (patch)
tree50aea3f2a8329deef265befaa7aeddfa644d950c
parent5fd89ce15d83deaa780278a229a23085980d78d8 (diff)
update readme
-rw-r--r--README.md34
1 files changed, 22 insertions, 12 deletions
diff --git a/README.md b/README.md
index 57245ed2..29c48ccf 100644
--- a/README.md
+++ b/README.md
@@ -29,22 +29,32 @@ Please report bugs and issues on [GitHub](https://github.com/jpbruyere/Crow/issu
- Inlined delegates in XML
####Requirements :
-- **C#6** compatible compiler.
-- 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)
+- Mono >= 4.0 Framework.
+- [airo Graphic Library](https://cairographics.org/) >= 1.10
+- [OpenTK](http://opentk.github.io/).
+- glib, gio, and gdk >= 3.0. (part of GTK 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` .
+####Installing dependencies
+#####On Linux
+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
+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.
+- Compile your solution using **xbuild** from Mono
####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
-msbuild /p:Configuration=Release Crow.sln # Build on .Net (Windows)
-xbuild /p:Configuration=Release Crow.sln # Build on Mono (Linux / Mac OS X)
+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` .
+