summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRoger <sachanroger@gmail.com>2019-09-04 11:10:28 +0000
committerBastien Nocera <hadess@hadess.net>2019-09-04 11:10:28 +0000
commit8863cb52f4cd8dc3e8914760b8a9538b496d0b77 (patch)
treed80002c8e59837c340f3a568bbd604a358a8335b /README.md
parent23b1d27cf7b4b363397b5793fd9d4d340b4095f4 (diff)
downloadgrilo-plugins-8863cb52f4cd8dc3e8914760b8a9538b496d0b77.tar.gz
README: Convert README to Markdown
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..de5cfca
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# grilo-plugins
+Thanks for using Grilo!
+
+## What is Grilo?
+Grilo is a framework for browsing and searching media content from various
+sources using a single API.
+
+## What is grilo-plugins?
+It is a collection of plugins for Grilo implementing Grilo's API for various
+multimedia content providers.
+
+## Where can I find more?
+We have a wiki page at: <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?
+If you are asking this then you should probably be reading Grilo's README
+file first :)
+
+## Building from git
+Make sure you have Grilo installed first! If you do then:
+
+```bash
+$ git clone https://gitlab.gnome.org/GNOME/grilo-plugins.git
+$ cd grilo-plugins
+$ meson . build
+$ ninja -C build
+$ sudo ninja -C build install
+```
+
+Enjoy! \ No newline at end of file