Basic information about the cereal emulator
This file describes utilities needed to compile and install cereal and some special features you should be aware of. READ IT TO THE END! You have been warned.
If you want to learn to use cereal, read the User's Tutorial in doc/user. For information on programming new cereal modules, see the Programmer's Guide in doc/prog.
cereal is copyright (C) 2002, 2003, 2004 Miloslav Trmac <mitr@volny.cz> and can be redistributed under conditions of the GNU General Public License, version 2. See the file COPYING for details. cereal comes with NO WARRANTY, to the maximum extent permitted by law.
Required utilities
The version numbers given below are the version numbers my packages have. I have not tried other versions and cannot currently guarantee that cereal will or will not work when using other versions. Reasonable patches to support different configurations are always welcome, though.
To compile cereal, you need the following: * C and C++ compiler supporting C99 (gcc 4.0.0) * libxml2, including development libraries (2.6.19) * KDE 3, including development libraries (3.4.0) Alternatively, you might be able to skip building the KDE-dependent code by passing --without-kde to configure.
To enhance cereal or develop cereal modules, you also need:
* GNU Autoconf (2.59)
* GNU automake (1.9.5)
* GNU Bison (2.0)
* xmlto supporting DocBook XML V4.2 (0.0.18)
* transfig (3.2.4)
Installation instructions
If you want to install cereal system-wide, it is best to use the same --prefix option to invoke `configure' as the KDE prefix. Otherwise most of the installed files will be ignored on older KDE versions. Recent kdelibs (I have checked 3.4.0) can detect the correct paths automatically on Linux.
For system-wide installation, an example RPM spec file is provided. Even when using this spec file, make sure that --prefix is right.
If you want to run cereal without installing it system-wide, you need to set up your environment so that cereal can locate three different groups of files.
In all cases below, you can also use symlinks instead of physically copying the files.
- Module description files from the xml directory: Point environment variable CEREAL_XML_DIR to the xml directory.
- 8051 KDE UI extension: put file kde8051/plugin_kc8051.rc to ~/.kde/share/apps/cereal/kpartplugins and files libkc8051.la and libkc8051.so from kde8051/.libs subdirectory of your build directory to ~/.kde/lib/kde3
- KDE XML GUI description files: put files kde/*.rc and ~/.kde/share/apps/cereal, khwconf/*.rc to ~/.kde/share/apps/cereal_khwconf, or just run cereal_khwconf from the khwconf directory and cereal_kde from the kde directory.
Admittedly not very simple and certainly not user-friendly.
Conclusion
You can stop reading this file now. Thanks for trying cereal!