prototyped edje_part scriptability and outsourced scriptability code to script.c
[mozilla_edje_plugin.git] / README
blobcf9000af9113701baaea9f96f8c9a5534f2c5a8d
1 what license is this software released on?
3         zlib/libpng license (see file COPYING in this directory)
5 --------------------------------------------------------------------------
7 what is it?
9         it is a plugin for mozilla-compatible web browsers based on the gecko engine (e.g. firefox, icemonkey, iceweasel, iceape, konqueror, opera). it is able to show Edje files in your browser window. Edje is the layout library of the Enlightenment Window Manager (DR17), based upon the Enlightenment Foundation Libraries (EFL).
11 what is it good for?
13         - initial goal
14         Enlightenemnt DR17 and various applications based upton the EFL are themeable with Enlightenments layout library (Edje). each theme is distributed in a precompiled packaged file. as Enlightenment DR17 and various applications get more and more popular, also more and more themes are created. distribution takes place over the web. preview of the theme is done mostly by providing a screenshot of the theme in action. this plugin gives you the possibility to preview the theme in realtime.
16         - future goal
17         Edje is a powerful tool to create eye-candy user interfaces. if we have already a mozilla plugin, why not enhance it and use it as a replacement for flash objects in web pages?
19 what platforms are supported?
20         
21         until now, only X11 as graphical backend is supported, e.g. it should run on any unix where firefox is known to run on (apart from Mac OSX, its not using X11!).
23 who may use it?
25         me of course! but it may me useful to you, too.
27 --------------------------------------------------------------------------
29 required libraries and development packages/headers
30         1) libecore-dev
31         2) libevas-dev
32         3) libedje-dev
33         4) xulrunner-dev (on Debian GNU/Linux)
34         depending on your unix flavour, you may need another package here, e.g. SDK of mozilla, gecko, xulrunner, iceape, icemonkey, firefox, iceweasel or yet another fork ;-)
35         5) pkg-config (required for the autotools)
36         6) autotools (aclocal, autoconf, libtool, automake)
38 --------------------------------------------------------------------------
40 build
42         - default strategy
43         1) ./autogen.sh
44         2) ./configure
45         3) make
47 --------------------------------------------------------------------------
49 install
51         - default strategy
52         1) make install (plugin gets installed in your home directory ~/.mozilla/plugins/mozilla-edje-plugin.so)
54 --------------------------------------------------------------------------
56 directory structure
58         root (root directory)
59         |- m4 (files needed for macro processor of autobuild process)
60         |- data (config)
61         |- test (test framework)
62         |- src (source tree)
64 --------------------------------------------------------------------------