ethumb: Fix license on ethumbd.c too.
[profile/ivi/ethumb.git] / README
1 Ethumb 1.7.0
2
3 ******************************************************************************
4
5  FOR ANY ISSUES PLEASE EMAIL:
6  enlightenment-devel@lists.sourceforge.net
7
8 ******************************************************************************
9   
10 Ethumb - Thumbnail generation library
11
12
13 FEATURES
14 ========
15
16  * create thumbnails with a predefined frame (possibly an edje frame);
17  * have an option to create fdo-like thumbnails;
18  * have a client/server utility.
19
20
21 API
22 ===
23
24 It's possible to set the following properties of thumbnails:
25
26  * size
27  * format (jpeg, png, eet...)
28  * aspect:
29     * have crop?
30     * crop alignment?
31  * video:
32     * video_time
33  * document:
34     * page
35  * frame: edje file, group and swallow part to use when generating
36    thumbnails
37  * directory: directory where to save thumbnails
38  * category: to be used as DIRECTORY/CATEGORY/md5.format
39
40 Path generation should provide the following:
41
42  * If no path to save the thumbnail is specified, the following is used:
43    * if CATEGORY, return ~/.thumbnail/CATEGORY/md5.format
44    * else if size (128x128 or 256x256), format (png), aspect (keep
45      aspect, no crop) and no frame matches, return
46      ~/.thumbnail/{normal,large}/md5.png
47    * else return WxH-FORMAT-[framed-]ASPECT
48
49 Client server provides the following:
50  * multiple client support
51  * per-client configuration, avoid exchanging parameters over and over
52    again
53  * per-client queue, when client disconnect (ie: dies), remove whole
54    queue
55  * all clients have same priority, so queue is mixed for processing
56  * cancel thumb generation request
57  * communication over (for now) dbus and (future) ecore-ipc and unix
58    sockets
59  * interface of client library is independent of the communication
60    method selected
61
62 ------------------------------------------------------------------------------
63 COMPILING AND INSTALLING:
64
65   ./configure
66   make
67 (do this as root unless you are installing in your users directories):
68   make install
69