summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThiago Mendes <thiago@posteo.de>2018-09-25 00:27:05 +0200
committerVictor Toso <me@victortoso.com>2018-09-25 11:21:37 +0200
commit01a4517e362c087d69ec0726e17941c5b75267e6 (patch)
treee6c2dae1c487b6b08d4aff4bf301c7283961a078 /README.md
parent85a0a01c193bcee3905090467d2ee2177e10b0d5 (diff)
downloadgrilo-01a4517e362c087d69ec0726e17941c5b75267e6.tar.gz
docs: Use of Markdown Syntax
* Rename file README to README.md * Use of Markdown Syntax on README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md89
1 files changed, 89 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..12d5454
--- /dev/null
+++ b/README.md
@@ -0,0 +1,89 @@
+Thanks for using Grilo!
+
+# What is Grilo?
+
+Grilo is a framework for browsing and searching media content from various
+sources using a single API.
+
+# Where can I find more?
+
+We have a [wiki page](https://wiki.gnome.org/Projects/Grilo)
+
+You can subscribe to our [mailing list](http://mail.gnome.org/mailman/listinfo/grilo-list)
+
+You can join us on the IRC:
+#grilo on GIMPNet
+
+# How do I start?
+
+Once you have Grilo installed, you may want to play around with the
+examples (See section "Examples") or check its documentation
+and tutorials (See section "Documentation").
+
+## Fedora
+
+```
+sudo dnf install grilo
+```
+
+## Archlinux
+
+```
+sudo pacman -S grilo
+```
+
+## Others
+
+Otherwise you have to download Grilo's source code from GNOME's repository and
+build it -don't worry, it takes only a few seconds-, see the section below if
+you want to do that.
+
+## Building from git
+
+```
+git clone https://gitlab.gnome.org/GNOME/grilo.git
+cd grilo
+meson . build
+ninja -C build
+sudo ninja -C build install
+```
+
+# Examples
+
+If you are looking for some example to play with you can try grilo-test-ui,
+a simple GTK+ based test application for testing purposes. You can find it
+under tools/grilo-test-ui. It allows users to:
+
+ * Browse predefined content categories from browseable sources (like
+"Youtube", "Jamendo" or "UPnP").
+ * Search content by text on searchable sources (like "Youtube", "Jamanedo"
+or "Flickr").
+ * Query sources using source-specific syntax (for sources implementing
+this feature).
+ * Organize and define the source's content hierarchy (for sources
+implementing this feature like "bookmarks" or
+"podcasts").
+ * Check available metadata for the media.
+
+For this application to work you need some Grilo plugins that act as media
+sources, that is, plugins that provide the actual content that you will
+browse and search using the application. You can get a bunch of plugins for
+Grilo from the [grilo-plugins page](https://gitlab.gnome.org/GNOME/grilo-plugins)
+
+If you are looking for a step-by-step guide from beginning to end, here it is:
+
+## Building Grilo-Plugins
+
+Check the [Grilo-Plugins README file](https://gitlab.gnome.org/GNOME/grilo-plugins/blob/master/README.md) for instructions
+
+## Compiling/Running grilo-test-ui
+
+```
+git clone https://gitlab.gnome.org/GNOME/grilo.git
+cd grilo
+meson . build
+ninja -C build
+./build/tools/grilo-test-ui/grilo-test-ui-0.3
+```
+
+Enjoy!