Archive-Team
/
sonarr-repo-only
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Cleanup README (#1622)

This commit is contained in:
Mitchell Cash 2017-01-19 06:31:20 +10:00 committed by Keivan Beigi
parent a2a49ce934
commit 38b65ba27d
1 changed files with 26 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
readme.md → README.md
View File

@ -1,53 +1,52 @@
# Sonarr # # Sonarr
Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
## 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.
* Automatically detects new episodes * Automatically detects new episodes
* Can scan your existing library and download any missing episodes * 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* * 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 * 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
* Fully configurable episode renaming * Fully configurable episode renaming
* 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)
* Full support for specials and multi-episode releases * Full support for specials and multi-episode releases
* 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)
- Visual Studio 2015 [Free Community Edition](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx) * [Git](https://git-scm.com/downloads)
- [Git](http://git-scm.com/downloads) * [NodeJS](https://nodejs.org/download/)
- [NodeJS](http://nodejs.org/download/)
### Setup ### ### Setup
- Make sure all the required software mentioned above are installed. * 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) * 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` * Grab the submodules `git submodule init && git submodule update`
- install the required Node Packages `npm install` * 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. * 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.* *Please note gulp must be running at all times while you are working with Sonarr client source files.*
### Development
### Development ### * Open `NzbDrone.sln` in Visual Studio
- Open `NzbDrone.sln` in Visual Studio * Make sure `NzbDrone.Console` is set as the startup project
- 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-2017
### 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/)