git.sur5r.net Git - minitube/blob - README.md

   1 # Build Instructions
   2
   3 ## Prerequisites
   4 To compile Minitube you need at least Qt 4.8.
   5 The following Qt modules are needed: core, gui, network, sql (using the Sqlite plugin), script, dbus, phonon
   6
   7 On a Debian or Ubuntu system type:
   8     $ sudo apt-get install build-essential qt4-dev-tools libphonon-dev
   9
  10 ## Google API Key
  11
  12 Google is now requiring an API key in order to access YouTube Data web services.
  13 Create a "Browser Key" at https://console.developers.google.com
  14
  15 The key must be specified at compile time as shown below.
  16 Alternatively Minitube can read an API key from the GOOGLE_API_KEY environment variable.
  17
  18 ## Compiling
  19 Run:
  20     $ qmake -DAPP_GOOGLE_API_KEY="YouAPIKeyHere"
  21 and then:
  22     $ make
  23 Beware of the Qt3 or Qt5 version of qmake! If things go wrong try running qmake-qt4 instead.
  24
  25 ## Running
  26 ./build/target/minitube
  27
  28 ## A word about Phonon on Linux
  29 To be able to actually watch videos you need a working Phonon setup.
  30 Please don't contact me about this, ask for help on your distribution support channels.
  31
  32 These days Minitube is tested with the VLC backend only.
  33 Please don't report bugs with other backends as they're not supported.
  34
  35 ## Installing on Linux
  36 Run:
  37     $ sudo make install
  38 This is for packagers. End users should not install applications in this way.
  39
  40 ## Legal Stuff
  41 Copyright (C) Flavio Tordini
  42
  43 This program is free software: you can redistribute it and/or modify
  44 it under the terms of the GNU General Public License as published by
  45 the Free Software Foundation, either version 3 of the License, or
  46 (at your option) any later version.
  47
  48 This program is distributed in the hope that it will be useful,
  49 but WITHOUT ANY WARRANTY; without even the implied warranty of
  50 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  51 GNU General Public License for more details.
  52
  53 You should have received a copy of the GNU General Public License
  54 along with this program.  If not, see <http://www.gnu.org/licenses/>.