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

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