From 0900cc583cc5e51b7c6b378de93cca29e11cb0e9 Mon Sep 17 00:00:00 2001 From: Chris Xiong Date: Fri, 28 Oct 2016 16:35:21 +0800 Subject: Add the GLFW port, still using OpenGL 2.1 though. And a more detailed readme. --- README.md | 34 +++++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f32db2e..bf89666 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,7 @@ _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 ~~totally useless~~ reference is now in the doc folder. A D3D version will be put into construction _soon_. @@ -21,12 +19,42 @@ Building dependencies on debian-based systems: >libfreetype6-dev libopenal-dev libsdl2-dev libpng-dev >libjpeg62-turbo-dev libvorbis-dev libogg-dev +Now there's also an experimental port that uses GLFW instead of SDL2. +Minor behavior differences exist between the two versions. + +Additional building dependencies for the GLFW version on a debian-base system: + +>libglfw3-dev libglew-dev + To build a module, just run make in the corresponding folder. The example must be built last. SMELT and applications that uses SMELT *REQUIRES* C++11 to build. +## Using SMELT: +Till now SMELT can only be built as a static library, which may make using SMELT +a bit clumsy... + +0. Build SMELT. Running "make" should do the trick for you. Sorry, MSVC users! +1. Add the include folder in the source tree to the C++ header search folder of you project. +2. Add the libraries dependencies. Library dependencies are listed as following: + +for the SDL2 version: + +> -lsmeltext -lsmelt[-dumb] -lCxImage [-lvorbis -lvorbisfile -lopenal] -ljpeg -lpng -lSDL2 + +for the GLFW version: + +> -lsmeltext -lsmelt[-dumb] -lCxImage [-lvorbis -lvorbisfile -lopenal] -ljpeg -lpng -lglfw -lGLEW -lGL + +...and start coding! + +## Customizing SMELT +Each implementation of SMELT has a file called smelt_config.hpp in its folder. +Modifying this file allows you to customize the functionality of SMELT. See the +comments in the file for details. + ## TODOs: * Example code. * Better documentation. -- cgit v1.2.3