index 282bec93cf16de5facdd8f2538521f37e619d07a..554653dfe97f642ddeb162f17b0bf41ed7aee86e 100644 (file)
--- a/README
+++ b/README
This is GStreamer, a framework for streaming media.
-This package is in the 0.9.x series. This means that this is a
-development series leading up to a stable 0.10.x series.
-You have been warned.
+WHERE TO START
+--------------
-GStreamer 0.9 development series - Hung by a Thread
----------------------------------------------------
+We have a website at
+http://gstreamer.freedesktop.org/
+
+You should start by going through our FAQ at
+http://gstreamer.freedesktop.org/data/doc/gstreamer/head/faq/html/
+
+There is more documentation; go to
+http://gstreamer.freedesktop.org/documentation
+
+You can subscribe to our mailing lists; see the website for details.
+
+We track bugs in GNOME's bugzilla; see the website for details.
+
+You can join us on IRC - #gstreamer on irc.freenode.org
+
+GStreamer 0.10 series
+---------------------
Starring
problem and send us a patch, or bribe someone into fixing them for you.
- New contributors can start here for things to work on.
+PLATFORMS
+---------
+
+- Linux is of course fully supported
+- FreeBSD is reported to work; other BSD's should work too
+- Solaris is reported to work; a specific sunaudiosink plugin has been written
+- MacOSX is reported to work; specific audio and video sinks have been written
+- Windows support is experimental but improving. Output sinks have been
+ written but are not yet included in the code. We support
+ - MSys/MinGW builds
+ - Microsoft Visual Studio 6 builds (see win32/README.txt)
+
INSTALLING FROM PACKAGES
------------------------
- want to hack on GStreamer
- want to verify that a bug has been fixed
- do not have a sane distribution
-should you choose to build from source tarballs or CVS.
+should you choose to build from source tarballs or git.
Find more information about the various packages at
http://gstreamer.freedesktop.org/download/
make
to build GStreamer.
-- if you want to install it (not required), run
+- if you want to install it (not required, but what you usually want to do), run
make install
-- You should create a registry for things to work.
- If you ran make install in the previous step, run
- gst-register
- as root.
-
- If you didn't install, run
- tools/gst-register
- as a normal user.
- try out a simple test:
- gst-launch fakesrc num_buffers=5 ! fakesink
- (If you didn't install GStreamer, again prefix gst-launch with tools/)
+ gst-launch -v fakesrc num_buffers=5 ! fakesink
+ (If you didn't install GStreamer, prefix gst-launch with tools/)
If it outputs a bunch of messages from fakesrc and fakesink, everything is
ok.
+ If it did not work, keep in mind that you might need to adjust the
+ PATH and/or LD_LIBRARY_PATH environment variables to make the system
+ find GStreamer in the prefix where you installed (by default that is /usr/local).
+
- After this, you're ready to install gst-plugins, which will provide the
functionality you're probably looking for by now, so go on and read
that README.
-COMPILING FROM CVS
+COMPILING FROM GIT
------------------
-When building from CVS sources, you will need to run autogen.sh to generate
+When building from git sources, you will need to run autogen.sh to generate
the build system files.
-You will need a set of additional tools typical for building from CVS,
+You will need a set of additional tools typical for building from git,
including:
- autoconf
- automake
After the autogen.sh stage, you can follow the directions listed in
"COMPILING FROM SOURCE"
-You can also run your whole cvs stack uninstalled. The script in
-the gstreamer module /docs/faq/gst-uninstalled) is helpful in setting
+You can also run your whole git stack uninstalled. The script in
+the gstreamer module /scripts/gst-uninstalled) is helpful in setting
up your environment for this.
PLUG-IN DEPENDENCIES AND LICENSES
GStreamer is developed under the terms of the LGPL (see LICENSE file for
details). Some of our plug-ins however rely on libraries which are available
-under other licenses. This means that if you are using an application which
-has a non-GPL compatible license (for instance a closed-source application)
-with GStreamer, you have to make sure not to use GPL-linked plug-ins.
+under other licenses. This means that if you are distributing an application
+which has a non-GPL compatible license (for instance a closed-source
+application) with GStreamer, you have to make sure not to distribute GPL-linked
+plug-ins.
+
When using GPL-linked plug-ins, GStreamer is for all practical reasons
under the GPL itself.