Lidarr/README.md

# Lidarr

Lidarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.

## Major Features Include:

* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
* Automatically detects new episodes
* Can scan your existing library and download any missing episodes
* Can watch for better quality of the episodes you already have and do an automatic upgrade. *eg. from DVD to Blu-Ray*
* Automatic failed download handling will try another release if one fails
* Manual search so you can pick any release or to see why a release was not downloaded automatically
* Fully configurable episode renaming
* Full integration with SABnzbd and NZBGet
* Full integration with Kodi, Plex (notification, library update, metadata)
* Full support for specials and multi-episode releases
* And a beautiful UI

## Feature Requests

[![Feature Requests](http://feathub.com/mattman86/Lidarr?format=svg)](http://feathub.com/mattman86/Lidarr)

## Configuring Development Environment:

### Requirements

* Visual Studio 2015 (https://www.visualstudio.com/vs/)
* [Git](https://git-scm.com/downloads)
* [NodeJS](https://nodejs.org/en/download/)

### Setup

* Make sure all the required software mentioned above are installed.
* Clone the repository into your development machine. [*info*](https://help.github.com/articles/working-with-repositories)
* Grab the submodules `git submodule init && git submodule update`
* Install the required Node Packages `npm install`
* Start gulp to monitor your dev environment for any changes that need post processing using `npm start` command.

*Please note gulp must be running at all times while you are working with Lidarr client source files.*

### Development

* Open `NzbDrone.sln` in Visual Studio
* Make sure `NzbDrone.Console` is set as the startup project

### License

* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
* Copyright 2010-2017
Update README.md 2017-03-30 16:56:45 +00:00			`# Lidarr`
Added Readme 2011-08-03 16:29:03 +00:00
Update README.md 2017-03-30 16:56:45 +00:00			`Lidarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.`
Update readme.md 2013-03-29 16:44:41 +00:00
Cleanup README (#1622) 2017-01-18 20:31:20 +00:00			`## Major Features Include:`
Update readme.md 2013-03-29 16:44:41 +00:00
Cleanup README (#1622) 2017-01-18 20:31:20 +00:00			`* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.`
Update readme.md 2013-03-29 16:44:41 +00:00			`* Automatically detects new episodes`
Update readme.md 2014-12-05 05:53:28 +00:00			`* Can scan your existing library and download any missing episodes`
			`* Can watch for better quality of the episodes you already have and do an automatic upgrade. eg. from DVD to Blu-Ray`
			`* Automatic failed download handling will try another release if one fails`
			`* Manual search so you can pick any release or to see why a release was not downloaded automatically`
			`* Fully configurable episode renaming`
Cleanup README (#1622) 2017-01-18 20:31:20 +00:00			`* Full integration with SABnzbd and NZBGet`
			`* Full integration with Kodi, Plex (notification, library update, metadata)`
Update readme.md 2014-12-05 05:53:28 +00:00			`* Full support for specials and multi-episode releases`
			`* And a beautiful UI`
Update readme.md 2013-03-29 16:44:41 +00:00
Update README.md 2017-03-31 03:34:40 +00:00			`## Feature Requests`

			`[![Feature Requests](http://feathub.com/mattman86/Lidarr?format=svg)](http://feathub.com/mattman86/Lidarr)`

Update README.md 2017-03-31 03:35:08 +00:00			`## Configuring Development Environment:`

Cleanup README (#1622) 2017-01-18 20:31:20 +00:00			`### Requirements`
Update readme.md 2013-03-29 16:44:41 +00:00
Update README.md 2017-01-28 04:56:07 +00:00			`* Visual Studio 2015 (https://www.visualstudio.com/vs/)`
Cleanup README (#1622) 2017-01-18 20:31:20 +00:00			`* [Git](https://git-scm.com/downloads)`
Update README.md 2017-03-19 06:34:37 +00:00			`* [NodeJS](https://nodejs.org/en/download/)`
Update readme.md 2013-03-29 16:44:41 +00:00
Cleanup README (#1622) 2017-01-18 20:31:20 +00:00			`### Setup`
Update readme.md 2013-03-29 16:44:41 +00:00
Cleanup README (#1622) 2017-01-18 20:31:20 +00:00			`* Make sure all the required software mentioned above are installed.`
			`* Clone the repository into your development machine. [info](https://help.github.com/articles/working-with-repositories)`
			* Grab the submodules `git submodule init && git submodule update`
			* Install the required Node Packages `npm install`
			* Start gulp to monitor your dev environment for any changes that need post processing using `npm start` command.
Update readme.md 2013-03-29 16:44:41 +00:00
Update README.md 2017-03-31 03:30:16 +00:00			`Please note gulp must be running at all times while you are working with Lidarr client source files.`
Update readme.md 2013-03-29 16:44:41 +00:00
Cleanup README (#1622) 2017-01-18 20:31:20 +00:00			`### Development`
Update readme.md 2013-03-29 16:44:41 +00:00
Cleanup README (#1622) 2017-01-18 20:31:20 +00:00			* Open `NzbDrone.sln` in Visual Studio
			* Make sure `NzbDrone.Console` is set as the startup project
Added GPL v3 to readme file 2012-03-04 18:02:06 +00:00
Cleanup README (#1622) 2017-01-18 20:31:20 +00:00			`### License`
Added GPL v3 to readme file 2012-03-04 18:02:06 +00:00
			`* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)`
Cleanup README (#1622) 2017-01-18 20:31:20 +00:00			`* Copyright 2010-2017`