Use markdown in README and display travis-ci build status for master branch.

Signed-off-by: Mariusz Fik <fisiu@opensuse.org>
This commit is contained in:
Mariusz Fik
2014-02-13 19:48:44 +01:00
parent 0303d2bf55
commit 756584043b

42
README.md Normal file
View File

@ -0,0 +1,42 @@
qBittorrent - A BitTorrent client in Qt4
------------------------------------------
[![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.
It aims to be a good alternative to all other bittorrent clients
out there. qBittorrent is fast, stable and provides unicode
support as well as many features.
This product includes GeoLite data created by MaxMind, available from
http://maxmind.com/
### 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.
For more information please visit:
http://www.qbittorrent.org
or our wiki here:
http://wiki.qbittorrent.org
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`
------------------------------------------
Christophe Dumez <chris@qbittorrent.org>