svn update: 48958 (latest:48959)
[framework/uifw/ecore.git] / README.in
1 Ecore @VERSION@
2
3 Requirements:
4 -------------
5
6 Must:
7   libc libm
8
9 Recommended:
10   libX11 libXext libXcursor libXprint libXinerama libXrandr libXss libXrender
11   libXcomposite libXfixes libXdamage libXdpms libXtest OpenSSL CURL
12
13 Optional:
14   XCB SDL DirectFB
15
16 Ecore is a clean and tiny event loop library with many modules to do
17 lots of convenient things for a programmer, to save time and effort.
18
19 It's small and lean, designed to work on embedded systems all the way
20 to large and powerful multi-cpu workstations. It serialises all system
21 signals, events etc. into a single event queue, that is easily
22 processed without needing to worry about concurrency. A properly
23 written, event-driven program using this kind of programming doesn't
24 need threads, nor has to worry about concurrency. It turns a program
25 into a state machine, and makes it very robust and easy to follow.
26
27 Ecore gives you other handy primitives, such as timers to tick over
28 for you and call specified functions at particular times so the
29 programmer can use this to do things, like animate, or time out on
30 connections or tasks that take too long etc.
31
32 Idle handlers are provided too, as well as calls on entering an idle
33 state (often a very good time to update the state of the program). All
34 events that enter the system are passed to specific callback functions
35 that the program sets up to handle those events. Handling them is
36 simple and other Ecore modules produce more events on the queue,
37 coming from other sources such as file descriptors etc.
38
39 Ecore also lets you have functions called when file descriptors become
40 active for reading or writing, allowing for streamlined, non-blocking
41 IO.
42
43 ------------------------------------------------------------------------------
44 COMPILING AND INSTALLING:
45
46   ./configure
47   make
48 (as root unless youa re installing in your users directories):
49   make install
50       
51 ------------------------------------------------------------------------------
52 BUILDING PACKAGES:
53
54 RPM: To build rpm packages:
55   
56   sudo rpm -ta @PACKAGE@-@VERSION@.tar.gz
57
58 You will find rpm packages in your system /usr/src/redhat/* dirs (note you may
59 not need to use sudo or root if you have your own ~/.rpmrc. see rpm documents
60 for more details)
61
62 DEB: To build deb packages:
63
64   tar zvf @PACKAGE@-@VERSION@.tar.gz
65   cd @PACKAGE@-@VERSION@
66   dpkg-buildpackage -us -uc -rfakeroot
67   cd ..
68   rm -rf @PACKAGE@-@VERSION@
69
70 You will find all the debian source, binary etc. packages put in the directory
71 where you first untarred the source tarball.