summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorCarsten Haitzler (Rasterman) <raster@rasterman.com>2013-11-29 19:08:33 +0900
committerCarsten Haitzler (Rasterman) <raster@rasterman.com>2013-11-29 19:09:53 +0900
commit56cc068d5471cb8523fa92200e7c238f45b775bd (patch)
tree6657cd8816e9708ce39e4396753ed60b8f596848 /README
parent87f8d95bd14b78b35b407fe7f85986a9e92d3910 (diff)
downloademotion_generic_players-56cc068d5471cb8523fa92200e7c238f45b775bd.tar.gz
readme - update readme for efl 1.8
lots of extra documentation and information now in the README
Diffstat (limited to 'README')
-rw-r--r--README56
1 files changed, 44 insertions, 12 deletions
diff --git a/README b/README
index 759cf9f..5d6fcec 100644
--- a/README
+++ b/README
@@ -1,33 +1,65 @@
-Emotion Generic Players 1.8.0.
+Emotion Generic Players 1.8.0
+=============================
******************************************************************************
-
FOR ANY ISSUES PLEASE EMAIL:
enlightenment-devel@lists.sourceforge.net
-
******************************************************************************
-Players for Emotion using "generic" module.
-
-EMOTION GENERIC PLAYERS
-=======================
+These are binary players for Emotion using the "generic" module.
-Emotion support multiple modules provided as shared-objects under
-${prefix}/lib/emotion/modules, making it extensible. However these
+Emotion supports multiple modules provided as shared-objects under
+PREFIX/lib/emotion/modules, making it extensible. However these
live in the same process as the application, thus problems handling
the media may crash or halt the application. Unfortunately media
handling is very error prone due multiple sources, sinks, decoders et
al, each with their own level of stability.
-To solve this emotion ships with a "generic" module that will be a
+To solve this, Emotion ships with a "generic" module that is a
layer to talk to another process, the "player", using pipes and shared
memory (shm). If this external process dies, the main application
remains working (without any media, of course). Thus it is safer and
-have some nice qualities as avoiding bringing in many libraries to
+has some nice side effects such as avoiding bringing in many libraries to
decode media, saving memory in the application process, etc.
A secondary benefit is that the generic player is a separate process
and does not link with the user application code or EFL, avoiding
-license conflicts. Many decoding libraries or elements exist in
+license conflicts. Many decoding libraries or elements exist with
conflicting licenses with GPL, LGPL or even proprietary code.
+
+REQUIREMENTS
+------------
+
+ vlc (library)
+
+
+COMPONENTS
+----------
+
+**VLC Generic Player:**
+
+//GPL v2 license//
+
+This is a binary that uses the VLC library (libvlc) to play videos
+inot shared memory.
+
+COMPILING AND INSTALLING
+------------------------
+
+ ./configure
+ make
+ sudo make install
+
+
+COMPILER FLAGS
+--------------
+
+You may want to change the install prefix for EFL with:
+
+ --prefix=/path/to/prefix
+
+**NOTE:**
+
+You should put generic players in the same prefix as EFL or they will
+not be found by EFL at runtime.