mirror/Radarr
1
0
Fork 0
mirror of https://github.com/Radarr/Radarr synced 2024-12-23 16:32:48 +00:00
Code Issues Releases Wiki Activity

Cleanup README

Browse source
This commit is contained in:
Mitchell Cash 2017-01-15 08:23:35 +10:00
parent 98856e6747
commit b3dfb960b5
No known key found for this signature in database
GPG key ID: E9054FE3C6008DB5
1 changed files with 35 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
readme.md → README.md
View file

@ -8,6 +8,7 @@
This fork of Sonarr aims to turn it into something like Couchpotato. This fork of Sonarr aims to turn it into something like Couchpotato.
## Currently working: ## Currently working:
* Adding new movies * Adding new movies
* Manually searching for releases of movies. * Manually searching for releases of movies.
* Automatically searching for releases. * Automatically searching for releases.
@ -19,11 +20,13 @@ This fork of Sonarr aims to turn it into something like Couchpotato.
* New TorrentPotato Indexer (Works well with [Jackett](https://github.com/Jackett/Jackett)) * New TorrentPotato Indexer (Works well with [Jackett](https://github.com/Jackett/Jackett))
## Planned Features: ## Planned Features:
* Scanning PreDB to know when a new release is available. * Scanning PreDB to know when a new release is available.
* Fixing the other Indexers and download clients. * Fixing the other Indexers and download clients.
* Importing of Sonarr config. * Importing of Sonarr config.
## Download ## Download
The latest precompiled binary versions can be found here: https://github.com/galli-leo/Radarr/releases. The latest precompiled binary versions can be found here: https://github.com/galli-leo/Radarr/releases.
To connect to the UI, fire up your browser and open localhost:7878 or your-ip:7878. To connect to the UI, fire up your browser and open localhost:7878 or your-ip:7878.
@ -38,46 +41,47 @@ For more up to date versions (but also sometimes broken), daily builds can be fo
* [Windows](https://leonardogalli.ch/radarr/builds/latest.php?os=windows) * [Windows](https://leonardogalli.ch/radarr/builds/latest.php?os=windows)
* [Linux](https://leonardogalli.ch/radarr/builds/latest.php?os=mono) * [Linux](https://leonardogalli.ch/radarr/builds/latest.php?os=mono)
## Major Features Include: ## ## Major Features Include:
* Support for major platforms: Windows, Linux, OSX, Raspberry Pi, etc. * Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
* Can watch for better quality of the movies you have and do an upgrade. * Can watch for better quality of the movies you have and do an automatic upgrade. *eg. from DVD to Blu-Ray*
* Automatic failed download handling will try another release if one fails * 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. * 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 SABnzbd and NZBGet
* Full integration with XBMC, Plex (notification, library update, metadata). * Full integration with Kodi, Plex (notification, library update, metadata)
* And a beautiful UI * And a beautiful UI
## Configuring Development Environment: ## ## Configuring Development Environment:
### Requirements ### ### Requirements
- Visual Studio 2015 [Free Community Edition](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx) or Mono
- [Git](http://git-scm.com/downloads)
- [NodeJS](http://nodejs.org/download/)
### Setup ### * Visual Studio 2015 [Free Community Edition](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx) or Mono
* [Git](https://git-scm.com/downloads)
* [NodeJS](https://nodejs.org/download/)
- Make sure all the required software mentioned above are installed. ### Setup
- 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 Sonarr client source files.* * 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 Radarr client source files.*
### Development ### ### Development
- Open `NzbDrone.sln` in Visual Studio or run the build.sh script, if Mono is installed.
- Make sure `NzbDrone.Console` is set as the startup project
* Open `NzbDrone.sln` in Visual Studio or run the build.sh script, if Mono is installed.
* Make sure `NzbDrone.Console` is set as the startup project
### License
### License ###
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html) * [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
Copyright 2010-2016 * Copyright 2010-2016
### Sponsors
### Sponsors ### * [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools
- [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools * [ReSharper](http://www.jetbrains.com/resharper/)
- [ReSharper](http://www.jetbrains.com/resharper/) * [WebStorm](http://www.jetbrains.com/webstorm/)
- [WebStorm](http://www.jetbrains.com/webstorm/) * [TeamCity](http://www.jetbrains.com/teamcity/)
- [TeamCity](http://www.jetbrains.com/teamcity/)