summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorOlivier CrĂȘte <olivier.crete@collabora.co.uk>2008-03-07 18:29:38 -0500
committerOlivier CrĂȘte <olivier.crete@collabora.co.uk>2008-03-07 18:34:42 -0500
commit3943f97ec5bb34a6d4ce3923e63ed171811b7dfa (patch)
treeb2960ca4e4633663d5a679552d122b2137b1ae87 /README
parent0f156f461995263cc5a68fc7acf4614942e5a4f9 (diff)
downloadfarstream-3943f97ec5bb34a6d4ce3923e63ed171811b7dfa.tar.gz
Add basic readme with build/run requirements
Diffstat (limited to 'README')
-rw-r--r--README35
1 files changed, 35 insertions, 0 deletions
diff --git a/README b/README
index e69de29b..ca7c3878 100644
--- a/README
+++ b/README
@@ -0,0 +1,35 @@
+Farsight 2
+==========
+
+http://farsight.freedesktop.org/
+
+Farsight 2 is a collection of GStreamer modules and libraries for
+videoconferencing. The API is described in the documentation in the
+docs/ directory.
+
+
+Requirements
+============
+
+Build time:
+ - gstreamer 0.10.17
+ - gst-plugins-base 0.10.17
+ - glib 2.12
+ - gtk-doc 1.3
+
+Run time:
+ All of the build time requirements plus
+ - gst-plugins-good 0.10.7
+ - gst-plugins-bad 0.10.6
+ - gst-plugins-farsight 0.12.6
+
+Multicast requires gst-plugins-bad CVS (or 0.10.7)
+Usable video requires h263 (encoder + decoder) from gst-ffmpeg
+
+For the python module and examples you also need:
+ - Python 2.1
+ - PyGObject 2.12
+ - PyGTK 2.10
+ - gst-python 0.10.10
+
+The tests require gst-check (which requires check)