diff --git a/README.md b/README.md index 15400fc1..f83b9a4a 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,34 @@

[Haxe](https://haxe.org/) bindings for [raylib](https://raylib.com), a simple and easy-to-use library to learn videogame programming, Currently works only for windows but feel free the expand to other platforms. -This binding is worked on by two people but if you want to work on the binding feel free to add the feature and make a pull request. +This binding is worked on by two people, but if you want to work on the binding feel free to add the feature and make a pull request. > Warning! The binding is in its early stage of development and may change at any moment, please use at your own risk Requirements ------------- - Haxe 4.0.0 or above -- Hxcpp (Haxe's C++ runtime) which you can install by using `haxelib insall hxcpp` -- MSVC v142 - VS 2019 C++ x64/x86 build tools for Windows +- (Windows only) MSVC v142 - VS 2019 C++ x64/x86 build tools - (Windows only) Windows 10 SDK Installation ------------- -1. Clone this repository -2. This repo can be used as a template -3. To compile: `haxe build.hxml` +To install hxRaylib just run ``haxelib git hxRaylib https://github.com/ForeignSasquatch/hxRaylib``. + +Usage +------ +In your project make a ``Build.hxml`` file with the following: +``` +-cp src +-cpp bin +-lib hxRaylib +-main Main +# Uncomment for the platform +#-D mac +#-D windows +#-D linux +``` +Put a ``Main.hx`` file in the **src/** directory with your Main class such as the example below. Example -------- @@ -37,7 +49,7 @@ class Main { BeginDrawing(); ClearBackground(RAYWHITE); - DrawText("Congrats! You created your first window using hxRaylib!", 100, 100, 20, RAYWHITE); + DrawText("Congrats! You created your first window using hxRaylib!", 100, 100, 20, BLACK); EndDrawing(); }