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