summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorCarsten Haitzler (Rasterman) <raster@rasterman.com>2013-11-29 19:07:55 +0900
committerCarsten Haitzler (Rasterman) <raster@rasterman.com>2013-11-29 19:07:55 +0900
commit1e82152339996cb2dbaeb13edea111ac3dc3e2ce (patch)
tree7eca4db82dd710aab1f24921bd56d51c1b8b6a27 /README
parentd91a6973187e56b3df767ee2e7043ce585b8eb08 (diff)
readme - update readme for efl 1.8
lots of extra documentation and information now in the README
Diffstat (limited to 'README')
-rw-r--r--README114
1 files changed, 99 insertions, 15 deletions
diff --git a/README b/README
index e8686a973..5e180fa77 100644
--- a/README
+++ b/README
@@ -1,28 +1,112 @@
1Elementary 1.8.0 1Elementary 1.8.0
2================
2 3
3****************************************************************************** 4******************************************************************************
4
5 FOR ANY ISSUES PLEASE EMAIL: 5 FOR ANY ISSUES PLEASE EMAIL:
6 enlightenment-devel@lists.sourceforge.net 6 enlightenment-devel@lists.sourceforge.net
7
8****************************************************************************** 7******************************************************************************
9
10Elementary
11 8
12A basic widget set library that is easy to use and is based on EFL. 9Elementary is a basic widget set library that is easy to use and is based on
13It provides the basic building blocks for creating applications and user 10EFL. It provides the basic building blocks for creating applications and user
14interfaces. 11interfaces.
15 12
16For more details about elementary widgets and how to use them kindly refer to 13For more details about elementary widgets and how to use them kindly refer to
17the following link. 14the following link for the latest documentation:
15
16http://www.enlightenment.org/p.php?p=docs
17
18
19COMPONENTS
20----------
21
22**Library:**
23
24//LGPL v2 license//
25
26The library you will find in src/lib/ and modules it loads as demos or
27actual implementations in src/modules/. The library depends on at
28least on default theme that is built in data/themes/ and some default
29config installed from config/.
30
31**Theme:**
32
33The default theme is large and includes data for every widget and then
34some. The Theme includes some images that are creative-commons
35licensed (see COPYING.images) and is otherwise considered LGPL as well
36as the library.
37
38**Test App:**
39
40There is a full test app in src/bin/ and you will find its main source
41as test.c with every test split into test_*.c files. This should serve
42as a general tester for Elementary as well as example code on writing
43UIs with Elementary. Run this app (once installed) with elementary_test.
44
45**Configuration App:**
46
47A simple rough configuration tool is provided called
48elementary_config. This tool allows you to play with some basic
49configuration of elementary and it saves your config in your home
50directory in ~/.elementary as well as applying it to all Elementary
51using applications. Themes are normally looked for in
52~/.elementary/themes and the system elementary data dir
53(PREFIX/share/elementary/themes/).
54
55
56COMPILING AND INSTALLING
57------------------------
58
59 ./configure
60 make
61 sudo make install
62
63If you have doxygen, then you csan build documentation with:
64
65 make doc
66
67You will find documentation in the doc/ directory.
68
69
70COMPILER FLAGS
71--------------
72
73You likely don't need static libraries most of the time so you can
74disable them with:
75
76 --disable-static
77
78You may want to change the install prefix for EFL with:
79
80 --prefix=/path/to/prefix
81
82There are also examples in src/examples/ as well. To compile examples
83use this option to configure:
84
85 --enable-build-examples
86
87Also you may wish to install the examples, then use:
88
89 --enable-install-examples
90
91
92REQUIREMENTS
93------------
94
95Elementary requires EFL to be installed and available first.
96
18 97
19http://docs.enlightenment.org/auto/elementary/ 98CONFIGURATION
99-------------
20 100
21------------------------------------------------------------------------------ 101Configuration for a user is normally stored in ~/.elementary/config,
22COMPILING AND INSTALLING: 102but if this does not exist, the system configuration in
103PREFIX/share/elementary/config is used instead. Overriding either of
104these is per-screen or per-virtual-desktop configuration that may be
105stored on the root window as a property in X11 or via appropriate
106other protocols depending on display system.
23 107
24 ./configure 108By default the profile.cfg file contains a config key that indicates
25 make 109the name of the profile to use. See config/Makefile.am as to how to
26(do this as root unless you are installing in your users directories): 110generate this. The directories each contain per-profile configuration.
27 make install 111The cfg files are files generated by Eet and can be generated from
28 112text. See the above Makefile.am