source: libcaca/trunk/doc/libcaca.dox @ 824

Last change on this file since 824 was 824, checked in by Sam Hocevar, 15 years ago
  • Documentation improvements. Wrote a small migration guide and added the skeleton of a tutorial for Jylam.
  • Property svn:keywords set to Id
File size: 1.9 KB
Line 
1/* $Id: libcaca.dox 824 2006-04-21 18:03:22Z sam $ */
2
3/** \mainpage libcaca Developer Documentation
4
5 \section intro Introduction
6
7 \e libcaca is a graphics library that outputs text instead of pixels,
8 so that it can work on older video cards or text terminals. It is not
9 unlike the famous AAlib library. \e libcaca can use almost any virtual
10 terminal to work, thus it should work on all Unix systems (including
11 Mac OS X) using either the slang library or the ncurses library, on DOS
12 using the conio library, and on Windows systems using either slang or
13 ncurses (through Cygwin emulation) or conio. There is also a native X11
14 driver, and an OpenGL driver (through freeglut) that does not require a
15 text terminal. For machines without a screen, the raw driver can be used
16 to send the output to another machine, using for instance cacaserver.
17
18 \e libcaca is free software, released under the Do What The Fuck You
19 Want To Public License. This ensures that no one, not even the \e libcaca
20 developers, will ever have anything to say about what you do with the
21 software. It used to be licensed under the GNU Lesser General Public
22 License, but that was not free enough.
23
24 \section devel Developer's documentation
25
26 \e libcaca relies on a low-level, device independent library, called
27 \e libcucul. \e libcucul can be used alone as a simple ASCII and/or
28 Unicode compositing canvas.
29
30 The complete \e libcucul and \e libcaca programming interface is
31 available from the cucul.h and caca.h headers.
32
33 Some other topics are covered by specific sections:
34
35 - \subpage tutorial
36 - \subpage migrating
37
38 \section user User's documentation
39
40 - \subpage env
41
42 \section misc Misc
43
44 - \subpage news
45 - \subpage authors
46 - \subpage thanks
47 - \subpage todo
48
49 \section license License
50
51 Permission is granted to copy, distribute and/or modify this document
52 under the terms of the Do What The Fuck You Want To Public License, version
53 2 as published by Sam Hocevar. For details see http://sam.zoy.org/wtfpl/ .
54
55*/
Note: See TracBrowser for help on using the repository browser.