Sonarr/readme.md

55 lines
2.2 KiB
Markdown
Raw Normal View History

2013-07-16 23:31:55 +00:00
# NzbDrone #
2011-08-03 16:29:03 +00:00
2013-08-12 23:52:37 +00: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.
2013-03-29 16:44:41 +00:00
## Major Features Include: ##
2013-08-12 23:53:17 +00:00
* Support for major platforms: Windows, Linux, OSX
2013-03-29 16:44:41 +00:00
* Automatically detects new episodes
2011-08-03 16:29:03 +00:00
* can scan your existing library and then download any old seasons that are missing
2013-03-29 16:44:41 +00:00
* can watch for better versions and upgrade your existing episodes. *eg. from DVD to Blu-Ray*
2014-08-29 06:40:17 +00:00
* automatic failed download handling
* manual search so you can pick any release or to see why a release was rejected
2011-08-03 16:29:03 +00:00
* fully configurable episode renaming
2014-08-29 06:40:17 +00:00
* full integration with SABNzbd and NzbGet
* full integration with XBMC,Plex (notification, library update, metadata)
2013-03-29 16:44:41 +00:00
* full support for specials and multi-episode releases
2013-08-12 23:52:37 +00:00
* beautiful UI
2013-03-29 16:44:41 +00:00
## Configuring Development Enviroment: ##
### Requirements ###
2014-08-29 06:40:17 +00:00
- Visual Studio 2013 ([Express Edition](http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-for-web "Express Edition") might work but not tested.)
2013-03-29 16:44:41 +00:00
- [Git](http://git-scm.com/downloads)
- [NodeJS](http://nodejs.org/download/)
2014-08-29 06:40:17 +00:00
- [Gulp](http://gulpjs.com)
2013-03-29 16:44:41 +00:00
### 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)
2014-08-29 06:40:17 +00:00
- install the required Node Packages `npm install`
- install gulp `npm install gulp -g`
- start gulp to monitor your dev environment for any changes that need post processing using `gulp watch` command.
2013-03-29 16:44:41 +00:00
2014-08-29 06:40:17 +00:00
*Please note gulp must be running at all times while you are working with NzbDrone client source files.*
2013-03-29 16:44:41 +00:00
### Development ###
2014-08-29 06:40:17 +00:00
- Open `NzbDrone.sln` in Visual Studio
2013-03-29 16:44:41 +00:00
- Make sure `NzbDrone.Console` is set as the startup project
2012-03-04 18:02:06 +00:00
2014-01-24 22:13:18 +00:00
### License ###
2012-03-04 18:02:06 +00:00
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
2014-08-29 06:40:17 +00:00
Copyright 2010-2014
2014-01-24 22:03:39 +00:00
2014-01-24 22:13:18 +00:00
### Sponsors ###
- [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools
- [ReSharper](http://www.jetbrains.com/resharper/)
2014-01-24 22:20:03 +00:00
- [WebStorm](http://www.jetbrains.com/webstorm/)
- [TeamCity](http://www.jetbrains.com/teamcity/)