Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
l0go committed Jul 1, 2021
1 parent 5e3cefb commit 5bf123e
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,34 @@
</p>

[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
--------
Expand All @@ -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();
}
Expand Down

0 comments on commit 5bf123e

Please sign in to comment.