README: flesh out a bit more to get people unfamiliar with autotools started

1 files changed, 27 insertions, 1 deletions

diff --git a/README b/README
index ac931f0..93c3d01 100644
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-This CVS module contains template code for possible GStreamer projects.
+This git module contains template code for possible GStreamer projects.
 
 gst-app
 	basic autotools layout for writing a GStreamer-based application.
@@ -14,6 +14,32 @@ recommend the use of the LGPL [2] license for applications and plugins,
 given the minefield of patents the multimedia is nowadays. See our website
 for details [3].
 
+Build each module like this:
+
+    cd gst-plugin
+    ./autogen.sh
+    make
+
+Modify gst-plugin/src/Makefile.am to add or remove source files to build or
+add additional dependencies or compiler flags or change the name of the
+plugin file to be installed. Run ./autoregen.sh if changes don't take effect
+automatically on 'make'.
+
+Modify gst-plugin/configure.ac to check for additional library dependencies
+or other features needed by your plugin. Run ./autoregen.sh if changes don't
+take effect automatically on 'make'.
+
+Once the plugin is built you can either install it with 'sudo make install'
+(however, this will by default go into the /usr/local prefix where it won't
+be picked up by a GStreamer installed from packages, so you would need to
+set the GST_PLUGIN_PATH environment variable to include or point to
+/usr/local/lib/gstreamer-0.10/ for your plugin to be found by a from-package
+GStreamer). Alternatively, you will find your plugin binary in
+gst-plugins/src/.libs/ as libgstplugin.so or similar (the extension may vary),
+so you can also set the GST_PLUGIN_PATH environmen variable to the
+gst-plugins/src/.libs/ directory (best to specify an absolute path though).
+
+
 [1] http://www.opensource.org/licenses/mit-license.php or COPYING.MIT
 [2] http://www.opensource.org/licenses/lgpl-license.php or COPYING.LIB
 [3] http://gstreamer.freedesktop.org/documentation/licensing.html