============================
LottaNZB - Usenet Downloader
============================

LottaNZB aims to simplify and automate the download of files from the Usenet.
You can tell LottaNZB what to download using NZB files, which are created by
many Usenet search engines.

LottaNZB integrates nicely with GNOME desktops, but is not limited to them
and uses the mature SABnzbd software as its foundation. It is Free Software
and licensed under the terms of the General Public License 3.

Homepage: http://www.lottanzb.org

We are always grateful to receive feedback in the form of bug reports and
feature requests.


Installation instructions
=========================

Required packages
-----------------

First, make sure you have the following packages installed. You don't need
SABnzbd if you only want to control the downloads of another computer.

- sabnzbdplus >= 0.5.2
- python >= 2.6
- python-gtk2 >= 2.16
- python-dbus
- python-configobj

Recommended packages
--------------------

There are several packages we highly recommend to install if you want to make
full use of LottaNZB's capabilities.

For building LottaNZB (not running it):

- intltool

For displaying the help content:

- yelp (>= 2.30)

For checking and repairing downloads:

- par2 (>= 0.4)

For automatic extraction of RAR archives:

- unrar (>= 3.6.6) (non-free)

For automatic extraction of ZIP archives:

- unzip (>= 5.52)

For RSS support:

- python-feedparser (>= 4.1)

For SSL encryption and HTTPS remote access support:

- python-openssl (>= 0.6)

For a significantly faster decoding of downloads:

- python-yenc (>= 0.3)

For opening the download directory from within LottaNZB:

- python-gnome2 (the gnomevfs module)

For assistance with the installation of SABnzbd on Debian-based distributions:

- python-apt (>= 0.6.13)
- apturl

The package names may vary depending on your distribution.

Build LottaNZB
--------------

    ``python setup.py build``

Install/Upgrade LottaNZB
------------------------

Run as root or by using sudo on Ubuntu systems:

    ``python setup.py install``

Launch LottaNZB
---------------

In a terminal:
   ``lottanzb``

Via the GNOME menu:
   Applications -> Internet -> LottaNZB Usenet Downloader

Have fun with LottaNZB!


Uninstallation instructions
===========================

When installing LottaNZB according to the steps described above, a file called
INSTALLED_FILES is created in the source directory. This file is required to
run the following command with root privileges:

    ``python setup.py uninstall``
