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

   1 <p align="center">
   2 <img src="https://flavio.tordini.org/files/products/minitube.png">
   3 </p>
   4
   5 # Minitube
   6 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.
   7
   8 ## Translating to your language
   9 Translations are done at https://www.transifex.com/flaviotordini/minitube/
  10 Just register and apply for a language team. Please don't request translation merges on GitHub.
  11
  12 ## Google API Key
  13 Google is now requiring an API key in order to access YouTube Data web services.
  14 Create a "Browser Key" at https://console.developers.google.com and enable the Youtube Data API.
  15
  16 The key must be specified at compile time as shown below.
  17 Alternatively Minitube can read an API key from the GOOGLE_API_KEY environment variable.
  18
  19 ## Build instructions
  20 Clone from Github:
  21
  22     git clone --recursive https://github.com/flaviotordini/minitube.git
  23
  24 You need Qt >= 5.10 and MPV >= 0.29.0. The following Qt modules are needed: core, gui, widgets, network, sql (using the Sqlite plugin), declarative, dbus, x11extras.
  25
  26 To be able to build on a Debian (or derivative) system:
  27
  28     sudo apt install build-essential qt5-default qttools5-dev-tools qt5-qmake qtdeclarative5-dev libqt5sql5-sqlite libqt5x11extras5-dev libmpv-dev
  29
  30 Compiling:
  31
  32     qmake "DEFINES += APP_GOOGLE_API_KEY=YourAPIKeyHere"
  33     make
  34
  35 Running:
  36
  37     build/target/minitube
  38
  39 Installing on Linux:
  40
  41 This is for packagers. End users should not install applications in this way.
  42
  43     sudo make install
  44
  45 ## Legal Stuff
  46 Copyright (C) Flavio Tordini
  47
  48 This program is free software: you can redistribute it and/or modify
  49 it under the terms of the GNU General Public License as published by
  50 the Free Software Foundation, either version 3 of the License, or
  51 (at your option) any later version.
  52
  53 This program is distributed in the hope that it will be useful,
  54 but WITHOUT ANY WARRANTY; without even the implied warranty of
  55 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  56 GNU General Public License for more details.
  57
  58 You should have received a copy of the GNU General Public License
  59 along with this program.  If not, see <http://www.gnu.org/licenses/>.