From 352abaf8972d60c3cec612fe6414bce77b89b0bc Mon Sep 17 00:00:00 2001 From: Kevin Funk Date: Fri, 16 Nov 2012 17:45:24 +0100 Subject: [PATCH] Convert README to markdown Github makes use of this fancy thing called markdown, so why don't use it? :) --- README | 52 ------------------------------------------------ README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+), 52 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 6c164747e..000000000 --- a/README +++ /dev/null @@ -1,52 +0,0 @@ -Compiling Tomahawk ------------------- - - $ mkdir build && cd build - $ cmake .. - $ make - - Start the application on Linux: - $ ./tomahawk - Start the application on OS X: - $ open tomahawk.app - - -Detailed building instructions for Ubuntu ------------------------------------------ - See: http://wiki.tomahawk-player.org/index.php/Building_Ubuntu_Binary_on_Precise_(12.04) - -Detailed building instructions for OS X ---------------------------------------- - See: http://wiki.tomahawk-player.org/index.php/Building_OS_X_Application_Bundle_on_Snow_Leopard_(10.6)_and_Lion_(10.7) - -Doxygen Documentation ---------------------- - See: http://dev.tomahawk-player.org/api/classes.html - - -Dependencies ------------- - - CMake 2.8.6 - http://www.cmake.org/ - Qt 4.7.0 - http://qt.nokia.com/ - QJson 0.7.1 - http://qjson.sourceforge.net/ - SQLite 3.6.22 - http://www.sqlite.org/ - TagLib 1.6.2 - http://developer.kde.org/~wheeler/taglib.html - Boost 1.3 - http://www.boost.org/ - CLucene 0.9.23 (0.9.21 will fail) - http://clucene.sourceforge.net/download.shtml - libechonest 2.0.0 - http://projects.kde.org/projects/playground/libs/libechonest/ - Attica 0.4.0 - ftp://ftp.kde.org/pub/kde/stable/attica/ - QuaZip 0.4.3 - http://quazip.sourceforge.net/ - liblastfm 1.0.1 - http://github.com/lastfm/liblastfm/ - - - The following dependencies are optional, but recommended: - - Jreen 1.0.5 - http://qutim.org/jreen / https://github.com/euroelessar/jreen - QTweetLib 0.5.0 - https://github.com/minimoog/QTweetLib - - Third party libraries that we ship with our source: - - MiniUPnP 1.6 - http://miniupnp.free.fr/ - -Enjoy! diff --git a/README.md b/README.md new file mode 100644 index 000000000..e1e111fce --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +Tomahawk +======== + +Compiling and running Tomahawk +------------------------------ + +Compile: + + $ mkdir build && cd build + $ cmake .. + $ make + +Start the application on Linux: + + $ ./tomahawk +Start the application on OS X: + + $ open tomahawk.app + + +Detailed building instructions for Ubuntu +----------------------------------------- +See: http://wiki.tomahawk-player.org/index.php/Building_Ubuntu_Binary_on_Precise_(12.04) + +Detailed building instructions for OS X +--------------------------------------- +See: http://wiki.tomahawk-player.org/index.php/Building_OS_X_Application_Bundle_on_Snow_Leopard_(10.6)_and_Lion_(10.7) + +Doxygen Documentation +--------------------- +See: http://dev.tomahawk-player.org/api/classes.html + +Dependencies +------------ + +Required dependencies: + +* CMake 2.8.6 - http://www.cmake.org/ +* Qt 4.7.0 - http://qt.nokia.com/ +* QJson 0.7.1 - http://qjson.sourceforge.net/ +* SQLite 3.6.22 - http://www.sqlite.org/ +* TagLib 1.6.2 - http://developer.kde.org/~wheeler/taglib.html +* Boost 1.3 - http://www.boost.org/ +* CLucene 0.9.23 (0.9.21 will fail) - http://clucene.sourceforge.net/download.shtml +* libechonest 2.0.0 - http://projects.kde.org/projects/playground/libs/libechonest/ +* Attica 0.4.0 - ftp://ftp.kde.org/pub/kde/stable/attica/ +* QuaZip 0.4.3 - http://quazip.sourceforge.net/ +* liblastfm 1.0.1 - http://github.com/lastfm/liblastfm/ + +The following dependencies are optional, but recommended: + +* Jreen 1.0.5 - http://qutim.org/jreen / https://github.com/euroelessar/jreen +* QTweetLib 0.5.0 - https://github.com/minimoog/QTweetLib + +Third party libraries that we ship with our source: + +* MiniUPnP 1.6 - http://miniupnp.free.fr/ + +Enjoy!