touchHLE/archived-rust-sdl2
1
0
Fork 0
mirror of https://github.com/touchHLE/rust-sdl2.git synced 2026-01-31 01:25:23 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
c943fb2a023bb5de0466a2354a11fec5fecd1052
archived-rust-sdl2/README.md
Tony Aldridge c943fb2a02 Started adding the bare basics in documentation
2013-08-17 10:43:55 +01:00

1.3 KiB
Raw Blame History

Rust-SDL2

Bindings for SDL2 in Rust

Overview

Rust-SDL2 is a library for talking to the new SDL2.0 libraries from Rust. Low-level C components are wrapped in Rust code to make them more idiomatic and abstract away inappropriate manual memory management.

In addition, it provides optional APIs to a number of common SDL extension libraries.

Rust-SDL2 uses the MIT license.

If you want a library compatible with earlier versions of SDL, please see https://github.com/brson/rust-sdl

Requirements

  • Rust - we currently compile against the Master branch. The releases on http://www.rust-lang.org tend to not work.
  • SDL2.0 development libraries - install through your favourite package management tool, or via http://www.libsdl.org/

Installation

Clone this repo, run ./configure, and then make. To see an example of the code in use, make demos.

Demo

To compile the demo:

rustc -L$PWD/src demo/demo.rc

Then run:

./demo/demo

Or you could instead just use

make demo

When things go wrong

Rust, and Rust-SDL2, are both still heavily in development, and you may run into teething issues when using this. Before panicking, check that you're using the latest Master branch of Rust, check that you've updated Rust-SDL2 to the latest version, and run make clean and ./configure. If that fails, please let us know on the issue tracker.