Package Upload
[framework/uifw/eet.git] / README
1 Eet 1.6.0
2
3 ******************************************************************************
4
5  FOR ANY ISSUES PLEASE EMAIL:
6  enlightenment-devel@lists.sourceforge.net
7
8 ******************************************************************************
9
10 Requirements:
11 -------------
12 Must have:
13   libc
14   zlib
15   libjpeg
16   eina (1.1.0 or better) 
17   (For windows you also need: evil)
18
19 Optional requirements:
20   gnutls (1.7.6 or better)
21   openssl
22
23 Eet is a tiny library designed to write an arbitrary set of chunks of
24 data to a file and optionally compress each chunk (very much like a
25 zip file) and allow fast random-access reading of the file later
26 on. It does not do zip as a zip itself has more complexity than is
27 needed, and it was much simpler to implement this once here.
28
29 It also can encode and decode data structures in memory, as well as
30 image data for saving to eet files or sending across the network to
31 other machines, or just writing to arbitrary files on the system. All
32 data is encoded in a platform independent way and can be written and
33 read by any architecture. This data once encoded can be sent to
34 another process or machine and decoded on the other end without
35 needing to go into an eet file. Eet can also optionally encrypt files
36 and use digital signatures (with gnutls or openssl support).
37
38 ------------------------------------------------------------------------------
39 COMPILING AND INSTALLING:
40
41   ./configure
42   make
43 (do this as root unless you are installing in your users directories):
44   make install
45
46 To get the coverage report:
47     make coverage
48 The report is created in the coverage/ subdir
49 If you want to be able to run coverage test over eet, you will need gcov 
50 (usually any distro provides it) and lcov from:
51   http://ltp.sourceforge.net/coverage/lcov.php.
52 For coverage support you also need "make check" support with the check
53 library (see below).
54  
55 For compilation with MinGW, fnmatch.h is probably missing. That file can be
56 found here:
57   http://www.koders.com/c/fid2B518462CB1EED3D4E31E271DB83CD1582F6EEBE.aspx
58 It should be installed in the mingw include directory.
59
60 For compilation with mingw32ce, run configure with the option
61   --host=arm-wince-mingw32ce
62
63 For compilation with cegcc, follow the wiki:
64   http://wiki.enlightenment.org/index.php/Category:EFL_Windows_CE
65
66 If you want to be able to run "make check", you need library check
67   from http://check.sourceforge.net/
68