Commit c0ade380 authored by Scott Deboy's avatar Scott Deboy

Updating README with latest build script argument details

parent a2444d81
......@@ -19,6 +19,9 @@ run this:
mkdir -p ~/bin ~/gst
git clone git@github.com:cablelabs/gstreamer-helper.git ~/gst/git
cd ~/gst/git
# If enabling introspection (required when building CVP2),
# include the --introspection argument
./build.sh
# The output of build.sh will tell you how to set GST_PLUGIN_PATH if you want
......@@ -54,13 +57,31 @@ See the section on "Using Uninstalled GStreamer" below.
First, look at the usage information from `./build.sh -h`:
> usage: ./build.sh \[-h --help ] \[-v --verbose] \[--no-update] \[--no-deps] \[--upstream]
> -h --help Print this help message.
> --no-update Don't pull and rebase before building.
> --no-deps Don't install dependencies before building.
> --reconfigure Force a reconfigure, even if a Makefile already exists.
> --upstream Clone from upstream where possible, instead of our repos (you probably don't want to do this).
> --introspection Enable introspection
usage: ./build.sh [-h | --help ] [--branch (branch name)]
[--disable-libtool | --enable-libtool] [--libtool-only]
[--introspection] [--no-update] [--no-deps]
[--reconfigure] [--upstream]
-h | --help Print this help message.
-v | --verbose Verbose build output.
--branch [branch] The branch to check out.
--disable-libtool (the default) - .la references in
*-uninstalled.pc files are replaced with
.so references, allowing QtWebKit
to be built
--enable-libtool .so references in *-uninstalled.pc files are
replaced with .la references, allowing CVP2
and Rygel to be built.
--libtool-only modify pkg-config files based on
the --enable-libtool or --disable-libtool
arguments - will not build or install dependencies
--introspection Enable introspection (required for CVP2
and Rygel builds)
--no-update Don't pull and rebase before building.
--no-deps Don't install dependencies before building.
--reconfigure Force a reconfigure, even if a Makefile already exists.
--upstream Clone from upstream where possible, instead of
our repos (you probably don't want to do this).
In general, you will want to run with the default arguments, but `--no-update`
can be useful if you just want to build everything, but don't want it to switch
......@@ -70,7 +91,8 @@ way to check if dependencies are installed is to attempt to install them).
`--upstream` exists because it's convenient in certain cases, but most likely
you shouldn't use it.
If you don't specify --no-update and also don't specify a --branch argument, your current branches will be switched over to ruih/master.
If you don't specify --no-update and also don't specify a --branch argument, your
current branches will be switched over to ruih/master.
## Setup
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment