diff --git a/README b/README.md similarity index 82% rename from README rename to README.md index aa9ad0a8f..40f59da27 100644 --- a/README +++ b/README.md @@ -1,8 +1,9 @@ qBittorrent - A BitTorrent client in Qt4 ------------------------------------------ -Description: +[![Build Status](https://travis-ci.org/qbittorrent/qBittorrent.png?branch=master)](https://travis-ci.org/qbittorrent/qBittorrent) ******************************** +###Description: qBittorrent is a bittorrent client programmed in C++ / Qt4 that uses libtorrent (sometimes called rblibtorrent) by Arvid Norberg. @@ -13,13 +14,14 @@ support as well as many features. This product includes GeoLite data created by MaxMind, available from http://maxmind.com/ -Installation: -******************************** +### Installation: For installation, follow the instructions from INSTALL file, but simple: +``` ./configure make && make install qbittorrent +``` will install and execute qBittorrent hopefully without any problem. @@ -33,7 +35,7 @@ Please report any bug (or feature request) to: http://bugs.qbittorrent.org You can also meet me (chris-qBT) on IRC: -#qbittorrent on irc.freenode.net +`#qbittorrent on irc.freenode.net` ------------------------------------------ Christophe Dumez