README

   1 WHAT IT IS
   2 ----------
   3 This is GStreamer, a framework for streaming media.  The
   4 fundamental design comes from the video pipeline at Oregon Graduate
   5 Institute, as well as some ideas from DirectMedia.  It's based on plug-ins
   6 that will provide the various codec and other functionality.  The
   7 interface hopefully is generic enough for various companies (ahem, Apple)
   8 to release binary codecs for Linux, until such time as they get a clue and
   9 release the source.
  10
  11 COMPILING FROM SOURCE
  12 ---------------------
  13 - check output of ./configure --help to see if any options apply to you
  14 - run
  15   ./configure
  16   make
  17
  18   to build GStreamer.
  19 - if you want to install it (not required), run
  20   make install
  21 - You should create a registry for things to work.
  22   If you ran make install in the previous step, run
  23   gst-register
  24   as root.
  25
  26   If you didn't install, run
  27   tools/gst-register
  28   as a normal user.
  29
  30 - try out a simple test:
  31   gst-launch fakesrc num_buffers=5 ! fakesink
  32   (If you didn't install GStreamer, again prefix gst-launch with tools/)
  33
  34   If it outputs a bunch of messages from fakesrc and fakesink, everything is
  35   ok.
  36
  37 - After this, you're ready to install gst-plugins, which will provide the
  38   functionality you're probably looking for by now, so go on and read
  39   that README.
  40
  41 COMPILING FROM CVS
  42 ------------------
  43 When building from CVS sources, you will need to run autogen.sh to generate
  44 the build system files.
  45
  46 GStreamer is cutting-edge stuff.  To be a CVS developer, you need
  47 what used to be considered cutting-edge tools.
  48
  49 ATM, most of us have at least these versions :
  50
  51 * autoconf      2.52    (NOT 2.52d)
  52 * automake      1.5
  53 * libtool       1.4     (NOT Gentoo's genetic failure 1.4.2)
  54 * pkg-config    0.8.0
  55
  56 autogen.sh will check for these versions and complain if you don't have
  57 them.  You can also specify specific versions of automake and autoconf with
  58 --with-automake and --with-autoconf
  59
  60 Check autogen.sh options by running autogen.sh --help
  61
  62 autogen.sh can pass on arguments to configure - you just need to separate them
  63 from autogen.sh with -- between the two.
  64 prefix has been added to autogen.sh but will be passed on to configure because
  65 some build scripts like that.
  66
  67 When you have done this once, you can use autoregen.sh to re-autogen with
  68 the last passed options as a handy shortcut.  Use it.
  69
  70 After the autogen.sh stage, you can follow the directions listed in
  71 "COMPILING FROM SOURCE"