]> git.sur5r.net Git - minitube/blobdiff - README.md
Remove top shadows
[minitube] / README.md
index d841e84c04a08e051c1f2e77e13c15b8a380bbd2..5f3396d26fb67bca79113ef9b62f99a20b2a31b0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,9 @@
-# Build Instructions
+# Minitube
+Minitube is a YouTube desktop application. It is written in C++ using the Qt framework. Contributing is welcome, especially in the Linux desktop integration area.
 
-## Prerequisites
-To compile Minitube you need at least Qt 4.8.
-The following Qt modules are needed: core, gui, network, sql (using the Sqlite plugin), script, dbus, phonon
-
-On a Debian or Ubuntu system type:
-    $ sudo apt-get install build-essential qt4-dev-tools libphonon-dev
+## Translating Minitube to your language
+Translations are done at https://www.transifex.com/projects/p/minitube/
+Just register and apply for a language team. Please don't request translation merges on GitHub.
 
 ## Google API Key
 
@@ -15,15 +13,30 @@ Create a "Browser Key" at https://console.developers.google.com
 The key must be specified at compile time as shown below.
 Alternatively Minitube can read an API key from the GOOGLE_API_KEY environment variable.
 
-## Compiling
-Run:
-    $ qmake -DAPP_GOOGLE_API_KEY="YouAPIKeyHere"
-and then:
+## Build instructions
+To compile Minitube you need at least Qt 4.8. The following Qt modules are needed:
+core, gui, network, sql (using the Sqlite plugin), script, dbus, phonon
+
+To be able to build on a Debian (or derivative) system:
+
+    $ sudo apt-get install build-essential qt4-dev-tools libphonon-dev libqt4-sql-sqlite
+
+Compiling:
+
+    $ qmake "DEFINES += APP_GOOGLE_API_KEY=YouAPIKeyHere"
     $ make
+
 Beware of the Qt3 or Qt5 version of qmake! If things go wrong try running qmake-qt4 instead.
 
-## Running
-./build/target/minitube
+Running:
+
+       $ build/target/minitube
+       
+Installing on Linux:
+
+    $ sudo make install
+
+This is for packagers. End users should not install applications in this way.
 
 ## A word about Phonon on Linux
 To be able to actually watch videos you need a working Phonon setup.
@@ -32,11 +45,6 @@ Please don't contact me about this, ask for help on your distribution support ch
 These days Minitube is tested with the VLC backend only.
 Please don't report bugs with other backends as they're not supported.
 
-## Installing on Linux
-Run:
-    $ sudo make install
-This is for packagers. End users should not install applications in this way.
-
 ## Legal Stuff
 Copyright (C) Flavio Tordini