Fix macro syntax errors.
[libale.git] / README
blob767af3a6db4cdab319b63cdfa46bd8937e083f40
1 README
2 ======
5 Overview
6 --------
8 libale is a library for synthetic capture and rendering.
11 Requirements
12 ------------
14 * GLUT
15 * GLEW
16 * libXi, libXmu (for GLUT detection)
17 * C++ compiler (for GLUT detection)
18 * Guile 1.8 or later
19 * For API open/save functions, ImageMagick 6.0.6 or later, or equivalent
22 Recommendations
23 ---------------
25 Add the following lines to ~/.guile to enable readline and history in the
26 sample client:
28 (use-modules (ice-9 readline))
29 (activate-readline)
30 (use-modules (ice-9 history))
32 Once readline is enabled, typing ale-<tab><tab> in the sample client will list
33 available libale functions.  ALE-<tab><tab> will list available enumerations.
36 Status
37 ------
39 libale is currently under development, as a spinoff from Ale:
41 http://auricle.dyndns.org/ALE/
44 Git repository
45 --------------
47 The libale git repository is hosted at repo.or.cz:
49 http://repo.or.cz/w/libale.git
52 // This README document is licensed under http://creativecommons.org/licenses/by-sa/3.0/