aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Chris Xiong <chirs241097@gmail.com> 2016-10-28 16:35:21 +0800
committerGravatar Chris Xiong <chirs241097@gmail.com> 2016-10-28 16:35:21 +0800
commit0900cc583cc5e51b7c6b378de93cca29e11cb0e9 (patch)
tree47625b45ad1d4d63eaa59b2414f89fbfda33d035 /README.md
parent6206029f2d0af3ef76a0a61ef024ca758307ba19 (diff)
downloadSMELT-0900cc583cc5e51b7c6b378de93cca29e11cb0e9.tar.xz
Add the GLFW port, still using OpenGL 2.1 though.
And a more detailed readme.
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 31 insertions, 3 deletions
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.