Radarr/readme.md

54 lines
2.1 KiB
Markdown
Raw Normal View History

2014-12-05 05:53:28 +00:00
# Sonarr #
2011-08-03 16:29:03 +00:00
2016-12-25 11:43:05 +00:00
This fork of Sonarr aims to turn it into something like Couchpotato.
At the moment almost nothing is implemented.
2013-03-29 16:44:41 +00:00
## Major Features Include: ##
2015-08-03 05:22:22 +00:00
* Support for major platforms: Windows, Linux, OSX, Raspberry Pi, etc.
2013-03-29 16:44:41 +00:00
* Automatically detects new episodes
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
* Full integration with SABNzbd and NzbGet
* Full integration with XBMC, Plex (notification, library update, metadata)
* Full support for specials and multi-episode releases
* And a beautiful UI
2013-03-29 16:44:41 +00:00
2014-12-05 05:53:28 +00:00
## Configuring Development Environment: ##
2013-03-29 16:44:41 +00:00
### Requirements ###
2015-12-12 19:24:46 +00:00
- Visual Studio 2015 [Free Community Edition](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx)
2013-03-29 16:44:41 +00:00
- [Git](http://git-scm.com/downloads)
- [NodeJS](http://nodejs.org/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`
2014-08-29 06:40:17 +00:00
- 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.
2013-03-29 16:44:41 +00:00
2015-08-03 05:22:22 +00:00
*Please note gulp must be running at all times while you are working with Sonarr 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)
2016-01-16 04:10:24 +00:00
Copyright 2010-2016
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
2014-12-05 05:53:28 +00:00
- [ReSharper](http://www.jetbrains.com/resharper/)
- [WebStorm](http://www.jetbrains.com/webstorm/)
- [TeamCity](http://www.jetbrains.com/teamcity/)