README.in

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