diff --git a/README.md b/README.md index 91859a8a..ecec82fe 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file