=========
 Kalisko
=========

Kalisko is a free modular application framework written in C.

--------------
 Dependencies
--------------

Core:

libglib

Modules:

libglfw
libglu
libglew
libfreeglut
liblua-5.1
libmozjs
libphp
libgtk+-2.0
gtksourceview-2.0
libpng

Build dependencies:

scons
pkg-config

-------------
 Compilation
-------------

Compile Kalisko's core:

$ scons

To compile the core and all modules you have to run:

$ scons modules=all

You can exclude certain modules with the 'exclude' statement, e.g.:

$ scons modules=all exclude=lang_php

You can also compile all modules necessary to run a particular module, e.g.,:

$ scons modules=http_server_demo expand_module_deps=1

For a complete list of build options run:

$ scons -h

------------
 Unit Tests
------------

Compile Kalisko's modules, unit test modules and unit test binary:

$ scons modules=all test_modules=all test=1

The directory src/tests contains all available unit test modules. To run all
built tests:

$ ./kalisko_test

To select names of test suites to run, pass '-t <test_suite_name>'

$ ./kalisko_test -t http_server

To run the unit tests for Kalisko's python utilities:

$ ./run_python_tests.py

---------
 Usage
---------

The directory 'src/modules' contains all available modules. To run a module
you have to pass '-m <module name>' to the kalisko binary. E.g.:

$ ./kalisko -m freegluttest

Only modules that implement a main loop can be started. Additional documentation
can be found in the wiki. http://www.kalisko.org/wiki