README

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