X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=README.md;h=4106a0e1c098e13f9589e8f114c5c30c63ac3e00;hb=c50ee0bebf749b188e7dd4217b9755c08cb4be88;hp=0d8ac19c9255221eeddc80e19fe420bcb66aa69a;hpb=fd2de342562fc7565ee7437636eb10c4456e0368;p=minitube diff --git a/README.md b/README.md index 0d8ac19..4106a0e 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,46 @@ +

+ +

+ # Minitube 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. -## Traslating Minitube to your language -Minitube translations are done at https://www.transifex.com/projects/p/minitube/ +## Translating to your language +Translations are done at https://www.transifex.com/flaviotordini/minitube/ Just register and apply for a language team. Please don't request translation merges on GitHub. -## Building -To compile Minitube you need at least Qt 4.8. The following Qt modules are needed: -core, gui, network, sql (using the Sqlite plugin), script, dbus, phonon - -On a Debian or Ubuntu system, type: - - $ sudo apt-get install build-essential qt4-dev-tools libphonon-dev - -### Google API Key - +## Google API Key Google is now requiring an API key in order to access YouTube Data web services. -Create a "Browser Key" at https://console.developers.google.com +Create a "Browser Key" at https://console.developers.google.com and enable the Youtube Data API. The key must be specified at compile time as shown below. Alternatively Minitube can read an API key from the GOOGLE_API_KEY environment variable. -### Compiling -Run: +## Build instructions +Clone from Github: - $ qmake -DAPP_GOOGLE_API_KEY="YouAPIKeyHere" + git clone --recursive https://github.com/flaviotordini/minitube.git -and then: +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. - $ make +To be able to build on a Debian (or derivative) system: -Beware of the Qt3 or Qt5 version of qmake! If things go wrong try running qmake-qt4 instead. + sudo apt install build-essential qt5-default qttools5-dev-tools qt5-qmake qtdeclarative5-dev libqt5sql5-sqlite libqt5x11extras5-dev libmpv-dev -### Running +Compiling: - $ ./build/target/minitube - -### Installing on Linux + qmake "DEFINES += APP_GOOGLE_API_KEY=YourAPIKeyHere" + make - $ sudo make install +Running: -This is for packagers. End users should not install applications in this way. + build/target/minitube -## A word about Phonon on Linux -To be able to actually watch videos you need a working Phonon setup. -Please don't contact me about this, ask for help on your distribution support channels. +Installing on Linux: + +This is for packagers. End users should not install applications in this way. -These days Minitube is tested with the VLC backend only. -Please don't report bugs with other backends as they're not supported. + sudo make install ## Legal Stuff Copyright (C) Flavio Tordini