Commit 8d42db04 authored by Florian Blasius's avatar Florian Blasius 🤘
Browse files

Merge branch 'master' of github.com:FloVanGH/orbgame

parents cbd41648 ce4e140f
......@@ -3,3 +3,30 @@ Orbital 2D Game Engine. Compatible with Redox and SDL2.
[![Travis Build Status](https://travis-ci.org/FloVanGH/orbgame.svg?branch=master)](https://travis-ci.org/FloVanGH/orbgame)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
## Usage
To include orbgame in your project, just add the dependency
line to your `Cargo.toml` file:
```text
orbgame = { git = "https://github.com/FloVanGH/orbgame.git" }
```
However you also need to have the SDL2 libraries installed on your
system. The best way to do this is documented [by the SDL2
crate](https://github.com/AngryLawyer/rust-sdl2#user-content-requirements).
## Examples
You find the examples in the `examples/` directory.
You can start the adventure example by executing the following command:
```text
cargo run --example adventure
```
## Credits
* https://opengameart.org/content/zelda-like-tilesets-and-sprites
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment