Requirements

Development libraries alongside with their tested versions (as of this writing) are given below:

• Lua-5.1.2
• libX11-1.1.3 (for the x11 driver)
• libXft-2.1.12 (for the x11 driver)
• fontconfig-2.5.0 (for the x11 driver)
• freetype-2.3.5 (for the x11 and dfb drivers)
• DirectFB-0.9.25.1 (for the dfb driver)

LibXft and fontconfig are needed for building the x11 driver, but tekUI falls back to the core X11 API if they are unavailable at runtime. Additionally, for the DirList class to work, an installation of the LuaFileSystem package is needed.

Linux note: By popular request, the names of packages required to compile and run tekUI on Ubuntu Linux 8.04 are: lua5.1, liblua5.1-0-dev, liblua5.1-filesystem0, libfreetype6-dev, libxft-dev, libxext-dev.

Adjusting the build environment

This release has been tested on and should compile and run out of the box on

• Ubuntu Linux 8.04 and 7.10
• FreeBSD 7.0
• Gentoo Linux x86/2008.0, x86/2007.0, amd64/2006.0

If building fails for you, you have to adjust the build environment, which is located in the config file on the topmost directory level. Supported build tools are gmake (common under Linux) and pmake (common under FreeBSD).

FreeBSD note: You need a Lua interpreter which is linked with the -pthread option, as tekUI is using multithreaded code in shared libraries, which are dynamically loaded by the interpreter.

Building

To see all build targets, type

# make help

The regular build procedure is invoked with

# make all

Installation

A system-wide installation of tekUI is not strictly required (in so far as the X11 driver is concerned. The DirectFB driver, in contrast, looks up fonts and cursors globally and must be installed anyway).

Once tekUI is built, it can be worked with and developed against, as long as you stay in the top-level directory of the distribution; all required modules and classes will be found if programs are started from there, e.g.:

# bin/demo.lua

If staying in the top-level directory is not desirable, then tekUI must be installed globally. By default, the installation paths are

• /usr/local/lib/lua/5.1
• /usr/local/share/lua/5.1

It is not unlikely that this is different from what is common for your operating system, distribution or development needs, so be sure to adjust these paths in the config file. The installation is conveniently invoked with

# sudo make install