Blame README

Packit 67b98c
Thanks for using Grilo!
Packit 67b98c
Packit 67b98c
=== What is Grilo? ===
Packit 67b98c
Packit 67b98c
Grilo is a framework for browsing and searching media content from various
Packit 67b98c
sources using a single API.
Packit 67b98c
Packit 67b98c
=== Where can I find more? ===
Packit 67b98c
Packit 67b98c
We have a wiki page at
Packit 67b98c
https://wiki.gnome.org/Projects/Grilo
Packit 67b98c
Packit 67b98c
You can subscribe to our mailing list:
Packit 67b98c
http://mail.gnome.org/mailman/listinfo/grilo-list
Packit 67b98c
Packit 67b98c
You can join us on the IRC:
Packit 67b98c
#grilo on GIMPNet
Packit 67b98c
Packit 67b98c
=== How do I start? ===
Packit 67b98c
Packit 67b98c
If you are using Ubuntu you can install binary packages by configuring
Packit 67b98c
our PPA, check the wiki page above for details. Otherwise you  have
Packit 67b98c
to download Grilo's source code from GNOME's repository and build it
Packit 67b98c
-don't worry, it takes only a few seconds-, see the section below
Packit 67b98c
if you want to do that.
Packit 67b98c
Packit 67b98c
Once you have Grilo installed, you may want to play around with the
Packit 67b98c
examples (See section "Examples") or check its documentation 
Packit 67b98c
and tutorials (See section "Documentation").
Packit 67b98c
Packit 67b98c
=== Building from git ===
Packit 67b98c
Packit 67b98c
$ git clone git://git.gnome.org/grilo
Packit 67b98c
$ cd grilo
Packit 67b98c
$ ./autogen.sh
Packit 67b98c
$ make
Packit 67b98c
Packit 67b98c
=== Examples ===
Packit 67b98c
Packit 67b98c
If you are looking for some example to play with you can try grilo-test-ui,
Packit 67b98c
a simple GTK+ based test application for testing purposes. You can find it
Packit 67b98c
under tools/grilo-test-ui. It allows users to:
Packit 67b98c
Packit 67b98c
1) Browse predefined content categories from browseable sources (like
Packit 67b98c
"Youtube", "Jamendo" or "UPnP").
Packit 67b98c
2) Search content by text on searchable sources (like "Youtube", "Jamanedo"
Packit 67b98c
or "Flickr").
Packit 67b98c
3) Query sources using source-specific syntax (for sources implementing
Packit 67b98c
this feature).
Packit 67b98c
4) Organize and define the source's content hierarchy (for sources
Packit 67b98c
implementing this feature like "bookmarks" or
Packit 67b98c
"podcasts").
Packit 67b98c
5) Check available metadata for the media. 
Packit 67b98c
Packit 67b98c
For this application to work you need some Grilo plugins that act as media
Packit 67b98c
sources, that is, plugins that provide the actual content that you will
Packit 67b98c
browse and search using the application. You can get a bunch of plugins for
Packit 67b98c
Grilo from the grilo-plugins package here:
Packit 67b98c
Packit 67b98c
http://git.gnome.org/browse/grilo-plugins
Packit 67b98c
Packit 67b98c
If you are looking for a step-by-step guide from beginning to end, here it is:
Packit 67b98c
Packit 67b98c
# Building Grilo
Packit 67b98c
Packit 67b98c
$ git clone git://git.gnome.org/grilo
Packit 67b98c
$ cd grilo
Packit 67b98c
$ ./autogen.sh
Packit 67b98c
$ make
Packit 67b98c
Packit 67b98c
# Building Grilo Plugins and setting GRL_PLUGIN_PATH
Packit 67b98c
Packit 67b98c
$ export PKG_CONFIG_PATH=$PWD:$PKG_CONFIG_PATH
Packit 67b98c
$ cd ..
Packit 67b98c
$ git clone git://git.gnome.org/grilo-plugins
Packit 67b98c
$ cd grilo-plugins
Packit 67b98c
$ ./autogen.sh
Packit 67b98c
$ make
Packit 67b98c
$ make install
Packit 67b98c
Packit 67b98c
# Running grilo-test-ui
Packit 67b98c
Packit 67b98c
$ cd ../grilo
Packit 67b98c
$ tools/grilo-test-ui/grilo-test-ui
Packit 67b98c
Packit 67b98c
=== Documentation ===
Packit 67b98c
Packit 67b98c
If you are looking for documentation you should add the --enable-gtk-doc
Packit 67b98c
option to the autogen.sh execution:
Packit 67b98c
Packit 67b98c
$ ./autogen.sh --enable-gtk-doc
Packit 67b98c
$ make
Packit 67b98c
Packit 67b98c
Then point your browser to open the file doc/reference/html/index.html
Packit 67b98c
Packit 67b98c
Enjoy!