summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README19
1 files changed, 14 insertions, 5 deletions
diff --git a/README b/README
index 9bcb810ba..b8392ba2c 100644
--- a/README
+++ b/README
@@ -3,12 +3,21 @@
xine
----------------------
- a free video player
+ free multimedia
+xine-lib is a free multimedia engine, released under the GPL.
+
+see the doc/ directory for more information about xine-lib. You will find
+various README files, FAQ and developer documentation (xine hacker's guide)
+there. Developers will find additional documentation for xine interfaces
+in the form of header file comments in the xine sources (for example the
+xine-lib API is documented in the include/xine.h header file).
+
+Individual frontends (e.g. xine-ui, gxine, totem, ...) may provide
+additional documentation in their packages.
+
+For more information on xine features (supported multimedia formats etc.)
+see the xine homepage, located at http://xine.sf.net
-for general information about xine and help on usage please refer to
-the documentation in the package xine-ui, directory "doc/".
-for technical documentation and stuff of interest for developers
-please see the directory "doc/" in the package xine-lib.