From fa1a4392b3d0ce65ebb47157c90008034b156df7 Mon Sep 17 00:00:00 2001 From: Chris Xiong Date: Wed, 7 Oct 2015 21:25:25 +0800 Subject: Add comments in the example program. Update readme. Add tap.ogg. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 99af39d..66763a1 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,33 @@ # SMELT _SMELT -- The engine behind BLR3+._ + _Now has its own repo._ A bad, bad reference is now in the doc folder. + Currently only the SDL version is available. + A D3D version will be put into construction _soon_. +Building +-------- +Building the SDL version of SMELT is only officially tested +on debian sid and debian jessie. + +Theoretically the SDL version should work on Windows +with little modification :) + +Building dependencies on debian-based systems: + +>libfreetype6-dev libopenal-dev libsdl2-dev libpng12-dev +>libjpeg62-turbo-dev libvorbis-dev libogg-dev + +To build a module, just run make in the corresponding folder. + +The example must be built last. + TODOs: +------ * Example code. * Better documentation. * D3D version. -- cgit v1.2.3