Quick start guide: Grilo Reference Manual

## Quick start guide

If you just want to have a go at Grilo as soon as possible this is the right section for you.

This section gives basic instructions on how to download, build and demo the development version of Grilo directly from the source code repositories, as well as how to build programs that use Grilo.

### Building Grilo from sources

    # Building Grilo
    $ git clone https://gitlab.gnome.org/GNOME/grilo.git
    $ cd grilo
    $ meson . build
    $ ninja -C build
    $ sudo ninja -C build install

    # Building Grilo Plugins
    $ cd ..
    $ git clone https://gitlab.gnome.org/GNOME/grilo-plugins.git
    $ cd grilo-plugins
    $ meson . build
    $ ninja -C build
    $ sudo ninja -C build install

You should now see the grilo libraries installed under /usr/lib and the plugins for grilo installed under /usr/lib/grilo-x.y, where 'x.y' represents the library version.

### Testing Grilo

After building and installing grilo and grilo-plugins, do:

    # Execute Grilo's test GUI
    $ /usr/bin/grilo-test-ui

This is a simple playground application that you can use to test the framework and its plugins.

Notice that grilo-test-ui is optional and will not be built unless you have the GTK+ development package installed on your system.

### Compiling Grilo based programs

    gcc -o example `pkg-config --cflags --libs grilo-x.y` example.c