Radarr/readme.md

72 lines
3.0 KiB
Markdown
Raw Normal View History

2017-01-02 10:45:11 +00:00
# Radarr [![Build Status](https://travis-ci.org/galli-leo/Radarr.svg?branch=develop)](https://travis-ci.org/galli-leo/Radarr)#
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.
2016-12-28 17:43:31 +00:00
## Currently working:
2017-01-04 11:15:56 +00:00
* Adding new movies
2016-12-28 17:43:31 +00:00
* Manually searching for releases of movies.
* Automatically searching for releases.
2017-01-06 18:24:40 +00:00
* Automatically importing downloaded movies.
* Recognizing Special Editions, Director's Cut, etc.
* Identifying releases with hardcoded subs.
* Rarbg.to, Torznab and Newznab Indexer.
* QBittorrent and Deluge download client (Other clients are coming)
* New TorrentPotato Indexer (Works well with [Jackett](https://github.com/Jackett/Jackett))
2016-12-28 17:43:31 +00:00
## Planned Features:
* Scanning PreDB to know when a new release is available.
2017-01-04 11:15:56 +00:00
* Fixing the other Indexers and download clients.
2016-12-28 17:43:31 +00:00
* Importing of Sonarr config.
2013-03-29 16:44:41 +00:00
2017-01-04 11:15:56 +00:00
## Download
The latest precompiled binary versions can be found here: https://github.com/galli-leo/Radarr/releases.
2017-01-05 16:50:22 +00:00
For more up to date versions (but also sometimes broken), daily builds can be found here:
* [OSX](https://leonardogalli.ch/radarr/builds/latest.php?os=osx)
* [Windows](https://leonardogalli.ch/radarr/builds/latest.php?os=windows)
* [Linux](https://leonardogalli.ch/radarr/builds/latest.php?os=mono)
2017-01-04 11:15:56 +00:00
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.
2017-01-06 18:24:40 +00:00
* Can watch for better quality of the movies you have and do an upgrade.
2014-12-05 05:53:28 +00:00
* Automatic failed download handling will try another release if one fails
2017-01-06 18:24:40 +00:00
* Manual search so you can pick any release or to see why a release was not downloaded automatically.
* Full integration with SABNzbd and NzbGet.
* Full integration with XBMC, Plex (notification, library update, metadata).
2014-12-05 05:53:28 +00:00
* 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 ###
2017-01-04 11:15:56 +00:00
- Visual Studio 2015 [Free Community Edition](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx) or Mono
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 ###
2017-01-04 11:15:56 +00:00
- Open `NzbDrone.sln` in Visual Studio or run the build.sh script, if Mono is installed.
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/)