libcaca/doc/libcaca.dox

/* $Id$ */

/** \mainpage libcaca Developer Documentation

 \section intro Introduction

 \e libcaca is a graphics library that outputs text instead of pixels,
 so that it can work on older video cards or text terminals. It is not
 unlike the famous AAlib library. \e libcaca can use almost any virtual
 terminal to work, thus it should work on all Unix systems (including
 Mac OS X) using either the slang library or the ncurses library, on DOS
 using the conio library, and on Windows systems using either slang or
 ncurses (through Cygwin emulation) or conio. There is also a native X11
 driver, and an OpenGL driver (through freeglut) that does not require a
 text terminal. For machines without a screen, the raw driver can be used
 to send the output to another machine, using for instance cacaserver.

 \e libcaca is free software, released under the Do What The Fuck You
 Want To Public License. This ensures that no one, not even the \e libcaca
 developers, will ever have anything to say about what you do with the
 software. It used to be licensed under the GNU Lesser General Public
 License, but that was not free enough.

 \section devel Developer's documentation

 \e libcaca relies on a low-level, device independent library, called
 \e libcucul. \e libcucul can be used alone as a simple ASCII and/or
 Unicode compositing canvas.

 The complete \e libcucul and \e libcaca programming interface is
 available from the cucul.h and caca.h headers.

 Some other topics are covered by specific sections:

 - \subpage tutorial
 - \subpage migrating

 \section user User's documentation

 - \subpage env

 \section misc Misc

 - \subpage news
 - \subpage authors
 - \subpage thanks
 - \subpage todo

 \section license License

 Permission is granted to copy, distribute and/or modify this document
 under the terms of the Do What The Fuck You Want To Public License, version
 2 as published by Sam Hocevar. For details see http://sam.zoy.org/wtfpl/ .

*/