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