licenses, ugg
[platform/upstream/gstreamer.git] / README
diff --git a/README b/README
index c81194e..12c0836 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,6 @@
-This is gnome-streamer, a framework for streaming media in GNOME.  The
+WHAT IT IS
+----------
+This is GStreamer, a framework for streaming media.  The
 fundamental design comes from the video pipeline at Oregon Graduate
 Institute, as well as some ideas from DirectMedia.  It's based on plug-ins
 that will provide the various codec and other functionality.  The
@@ -6,30 +8,64 @@ interface hopefully is generic enough for various companies (ahem, Apple)
 to release binary codecs for Linux, until such time as they get a clue and
 release the source.
 
+COMPILING FROM SOURCE
+---------------------
+- check output of ./configure --help to see if any options apply to you
+- run
+  ./configure
+  make
 
-Developer note:  When building from CVS sources, you will need to run
-autogen.sh to generate the build system files.
-
-Unfortunately, there is a bug in automake which causes it to use a large
-amount of memory when generating plugins/Makefile.in.  The following patch,
-which you may wish to apply to automake (version 1.4), fixes this problem.
-It is also fixed in versions of automake 1.4f and later.
-Alternatively, ensure that you have at least 512Mb of memory on your system,
-and be prepared to wait a little while when running automake (or autogen.sh).
-
-The autogen.sh script will automatically detect an unpatched automake and give
-a warning.  It will also generate a patched version of automake in the top
-build directory, which you can use by putting it in a directory in your $PATH
-ahead of the unpatched version of automake.
-
-@@ -2383,8 +2383,8 @@
-       # to all possible directories, and use it.  If DIST_SUBDIRS is
-       # defined, just use it.
-       local ($dist_subdir_name);
--      if (&variable_conditions ('SUBDIRS')
--          || &variable_defined ('DIST_SUBDIRS'))
-+      if (&variable_defined ('DIST_SUBDIRS')
-+          || &variable_conditions ('SUBDIRS'))
-       {
-           $dist_subdir_name = 'DIST_SUBDIRS';
-           if (! &variable_defined ('DIST_SUBDIRS'))
+  to build GStreamer.
+- if you want to install it (not required), 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/)
+
+  If it outputs a bunch of messages from fakesrc and fakesink, everything is
+  ok.
+
+- 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
+------------------
+When building from CVS sources, you will need to run autogen.sh to generate 
+the build system files.
+
+GStreamer is cutting-edge stuff.  To be a CVS developer, you need 
+what used to be considered cutting-edge tools.
+
+ATM, most of us have at least these versions :
+
+* autoconf     2.52    (NOT 2.52d)
+* automake     1.5
+* libtool      1.4     (NOT Gentoo's genetic failure 1.4.2)
+* pkg-config    0.8.0
+
+autogen.sh will check for these versions and complain if you don't have 
+them.  You can also specify specific versions of automake and autoconf with
+--with-automake and --with-autoconf
+
+Check autogen.sh options by running autogen.sh --help
+
+autogen.sh can pass on arguments to configure - you just need to separate them
+from autogen.sh with -- between the two.
+prefix has been added to autogen.sh but will be passed on to configure because
+some build scripts like that.
+
+When you have done this once, you can use autoregen.sh to re-autogen with
+the last passed options as a handy shortcut.  Use it.
+
+After the autogen.sh stage, you can follow the directions listed in
+"COMPILING FROM SOURCE"