better readme

master
Daniel Kolesa 2015-08-08 17:24:05 +01:00
parent bcc7b3d317
commit 285ad59995
1 changed files with 11 additions and 0 deletions

View File

@ -3,4 +3,15 @@
This is an embeddable version of the CubeScript implementation from the
Cube 2 engine.
It depends on the latest Git version of OctaSTD:
https://git.octaforge.org/tools/octastd.git/
https://github.com/OctaForge/OctaSTD
Currently the API is unstable and the whole thing is a work in progress.
You can compile your application with it like:
c++ myapp.cc cubescript.cc -o myapp -std=c++11 -Wall -Wextra -I. -Ipath/to/octastd
See COPYING.md for licensing information.