Sonarr/readme.md

# NzbDrone #


NZBDrone is a PVR for newsgroup users. It can monitor multiple RSS feeds for new episodes of your favourite shows and will grab, sorts and renames them. It can also be configured to automatically upgrade the quality of files already downloaded if a better quality format becomes available.

## Major Features Include: ##

* Support for major platforms: Windows, Linux, OSX
* Automatically detects new episodes
* can scan your existing library and then download any old seasons that are missing
* can watch for better versions and upgrade your existing episodes. *eg. from DVD to Blu-Ray*
* fully configurable episode renaming
* full integration with SABNzbd
* full integration with XBMC (notification, library update, metadata)
* full support for specials and multi-episode releases
* beautiful UI


## Configuring Development Enviroment: ##

### Requirements ###
- Visual Studio 2012 ([Express Edition](http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-for-web "Express Edition") might work but not tested.)
- [Git](http://git-scm.com/downloads)
- [NodeJS](http://nodejs.org/download/)
- [Grunt](http://gruntjs.com/getting-started)

### 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)
- install the required Node Packages using the following command `npm install`
- start grunt to monitor your dev environment for any changes that need post processing using `grunt` command.

*Please note grunt must be running at all times while you are working with NzbDrone source files.*


### Development ###
- Open `NzbDrone.sln` in Visual Studio 2012
- Make sure `NzbDrone.Console` is set as the startup project


### License ###
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
Copyright 2010-2013 


### Sponsors ###
- [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools
	- [ReSharper](http://www.jetbrains.com/resharper/)
	- [WebStorm](http://www.jetbrains.com/webstorm/)
	- [TeamCity](http://www.jetbrains.com/teamcity/)
Updated vnext description 2013-07-17 01:31:55 +02:00			`# NzbDrone #`
Added Readme 2011-08-03 18:29:03 +02:00

Update readme.md 2013-08-13 01:52:37 +02:00			`NZBDrone is a PVR for newsgroup users. It can monitor multiple RSS feeds for new episodes of your favourite shows and will grab, sorts and renames them. It can also be configured to automatically upgrade the quality of files already downloaded if a better quality format becomes available.`
Update readme.md 2013-03-29 17:44:41 +01:00
			`## Major Features Include: ##`

Update readme.md 2013-08-13 01:53:17 +02:00			`* Support for major platforms: Windows, Linux, OSX`
Update readme.md 2013-03-29 17:44:41 +01:00			`* Automatically detects new episodes`
Added Readme 2011-08-03 18:29:03 +02:00			`* can scan your existing library and then download any old seasons that are missing`
Update readme.md 2013-03-29 17:44:41 +01:00			`* can watch for better versions and upgrade your existing episodes. eg. from DVD to Blu-Ray`
Added Readme 2011-08-03 18:29:03 +02:00			`* fully configurable episode renaming`
Update readme.md 2013-03-29 17:44:41 +01:00			`* full integration with SABNzbd`
			`* full integration with XBMC (notification, library update, metadata)`
			`* full support for specials and multi-episode releases`
Update readme.md 2013-08-13 01:52:37 +02:00			`* beautiful UI`
Update readme.md 2013-03-29 17:44:41 +01:00

			`## Configuring Development Enviroment: ##`

			`### Requirements ###`
			`- Visual Studio 2012 ([Express Edition](http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-for-web "Express Edition") might work but not tested.)`
			`- [Git](http://git-scm.com/downloads)`
			`- [NodeJS](http://nodejs.org/download/)`
			`- [Grunt](http://gruntjs.com/getting-started)`

			`### 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)`
			- install the required Node Packages using the following command `npm install`
			- start grunt to monitor your dev environment for any changes that need post processing using `grunt` command.

			`Please note grunt must be running at all times while you are working with NzbDrone source files.`


			`### Development ###`
			- Open `NzbDrone.sln` in Visual Studio 2012
			- Make sure `NzbDrone.Console` is set as the startup project
Added GPL v3 to readme file 2012-03-04 19:02:06 +01:00

Fixed up readme a bit 2014-01-24 23:13:18 +01:00			`### License ###`
Added GPL v3 to readme file 2012-03-04 19:02:06 +01:00			`* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)`
Update readme.md 2013-03-29 17:44:41 +01:00			`Copyright 2010-2013`
updated readme 2014-01-24 23:03:39 +01:00

Fixed up readme a bit 2014-01-24 23:13:18 +01:00			`### Sponsors ###`
			`- [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools`
			`- [ReSharper](http://www.jetbrains.com/resharper/)`
Added link to teamcity 2014-01-24 23:20:03 +01:00			`- [WebStorm](http://www.jetbrains.com/webstorm/)`
			`- [TeamCity](http://www.jetbrains.com/teamcity/)`