aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Chris Xiong <chirs241097@gmail.com> 2015-10-07 21:25:25 +0800
committerGravatar Chris Xiong <chirs241097@gmail.com> 2015-10-07 21:25:25 +0800
commitfa1a4392b3d0ce65ebb47157c90008034b156df7 (patch)
treeb7de635f12145e19dc923d483a58b7c2e6701d6c /README.md
parentc93d16b6eb05984dc2c8ef474fe94d2136f6c0e2 (diff)
downloadSMELT-fa1a4392b3d0ce65ebb47157c90008034b156df7.tar.xz
Add comments in the example program.
Update readme. Add tap.ogg.
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
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.