libcubescript/README.md

25 lines
803 B
Markdown

# libcubescript
This is an embeddable version of the CubeScript implementation from the
Cube 2 engine. The API is highly unstable right now and overall it's a work
in progress.
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. It
requires C++14, just like OctaSTD does.
You can compile your application with it like:
c++ myapp.cc cubescript.cc -o myapp -std=c++14 -Wall -Wextra -I. -Ipath/to/octastd
It also supports building as a shared library. To do that, use the following
command line:
c++ cubescript.cc -o libcubescript.so -std=c++14 -Wall -Wextra -I. -Ipath/to/octastd -shared -fPIC
See COPYING.md for licensing information.