From: Doyoun Kang <doyoun.kang@samsung.com>
[framework/uifw/ecore.git] / README
1 Ecore 1.1.0
2
3 ******************************************************************************
4
5  FOR ANY ISSUES PLEASE EMAIL:
6  enlightenment-devel@lists.sourceforge.net
7   
8 ******************************************************************************
9   
10 Requirements:
11 -------------
12
13 Must:
14   libc
15   libm
16   eina (1.1.0 or better)
17   (For windows you also need: evil)
18   
19 Recommended:
20   libX11
21   libXext
22   libXcursor
23   libXprint
24   libXinerama
25   libXrandr
26   libXss
27   libXrender
28   libXcomposite
29   libXfixes
30   libXdamage
31   libXdpms
32   libXtest
33   GNUTLS or OpenSSL
34   CURL
35   evas (1.1.0 or better)
36
37 Optional:
38   XCB (fully working)
39   SDL
40   DirectFB
41   glib
42   tslib
43
44 Ecore is a clean and tiny event loop library with many modules to do
45 lots of convenient things for a programmer, to save time and effort.
46
47 It's small and lean, designed to work on embedded systems all the way
48 to large and powerful multi-cpu workstations. It serialises all system
49 signals, events etc. into a single event queue, that is easily
50 processed without needing to worry about concurrency. A properly
51 written, event-driven program using this kind of programming doesn't
52 need threads, nor has to worry about concurrency. It turns a program
53 into a state machine, and makes it very robust and easy to follow.
54
55 Ecore gives you other handy primitives, such as timers to tick over
56 for you and call specified functions at particular times so the
57 programmer can use this to do things, like animate, or time out on
58 connections or tasks that take too long etc.
59
60 Idle handlers are provided too, as well as calls on entering an idle
61 state (often a very good time to update the state of the program). All
62 events that enter the system are passed to specific callback functions
63 that the program sets up to handle those events. Handling them is
64 simple and other Ecore modules produce more events on the queue,
65 coming from other sources such as file descriptors etc.
66
67 Ecore also help you work in a multi threaded environment and setup a
68 thread pool that help you use the EFL on multi-cpu system. It help split
69 the part that can't be called outside of the ecore main loop from the
70 computation heavy function that could run on another CPU. Be aware that
71 Evas and most of Ecore API is not thread safe and should only be called
72 in the main loop. Eina and Eet could be used, if done carefully, in any
73 heavy function on another cpu.
74
75 Ecore also lets you have functions called when file descriptors become
76 active for reading or writing, allowing for streamlined, non-blocking
77 IO.
78
79 ------------------------------------------------------------------------------
80 COMPILING AND INSTALLING:
81
82   ./configure
83   make
84 (as root unless you are installing in your users directories):
85   make install
86       
87 ------------------------------------------------------------------------------
88 NOTE:
89
90 You can experience main loop lock (and more likely see UI lock) if libcurl
91 doesn't use an asynchronous dns resolver. Since Curl 7.21.0, you can use the
92 native dns resolver asynchronously by turning  --enable-threaded-resolver
93 on during configure time. For older version, C-Ares is the way to solve that
94 issue (see: http://c-ares.haxx.se/ ).