mirror/Sonarr
1
0
Fork 0
mirror of https://github.com/Sonarr/Sonarr synced 2024-12-23 00:07:07 +00:00
Code Issues Releases Wiki Activity

Updated README

Browse source
This commit is contained in:
Jef LeCompte 2020-01-04 22:57:13 -05:00 committed by Mark McDowall
parent 219494ea9d
commit 1b3839ac0d
1 changed files with 50 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

85
README.md
View file

@ -1,58 +1,73 @@
# Sonarr # <img width="24px" src="./Logo/256.png" alt="Sonarr"></img> 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: ## Getting Started
* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc. - [Download](https://sonarr.tv/#download) (Linux, MacOS, Windows, Docker, etc.)
* Automatically detects new episodes - [Installation](https://github.com/Sonarr/Sonarr/wiki/Installation)
* Can scan your existing library and download any missing episodes - [FAQ](https://github.com/Sonarr/Sonarr/wiki/FAQ)
* Can watch for better quality of the episodes you already have and do an automatic upgrade. *eg. from DVD to Blu-Ray* - [Wiki](https://github.com/Sonarr/Sonarr/wiki)
* Automatic failed download handling will try another release if one fails - [API Documentation](https://github.com/Sonarr/Sonarr/wiki/API)
* Manual search so you can pick any release or to see why a release was not downloaded automatically
* Fully configurable episode renaming ## Support
* Full integration with SABnzbd and NZBGet
* Full integration with Kodi, Plex (notification, library update, metadata) - [Donate](https://sonarr.tv/donate)
* Full support for specials and multi-episode releases - [Discord](https://discord.gg/M6BvZn5)
* And a beautiful UI - [Reddit](https://www.reddit.com/r/sonarr)
## Features
### Current Features
- Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
- Automatically detects new 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*
- 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 Kodi, Plex (notification, library update, metadata)
- Full support for specials and multi-episode releases
- And a beautiful UI
## Configuring Development Environment: ## Configuring Development Environment:
### Requirements ### Requirements
* [Visual Studio 2017](https://www.visualstudio.com/vs/) - [Visual Studio 2017](https://www.visualstudio.com/vs)
* [Git](https://git-scm.com/downloads) - [Git](https://git-scm.com/downloads)
* [NodeJS](https://nodejs.org/en/download/) - [NodeJS](https://nodejs.org/en/download)
* [Yarn](https://yarnpkg.com/) - [Yarn](https://yarnpkg.com)
### 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/en/articles/working-with-forks) - Clone the repository recursively to get Sonarr and it's submodules
* Grab the submodules `git submodule init && git submodule update` - You can do this by running `git clone --recursive https://github.com/Sonarr/Sonarr.git`
* Install the required Node Packages `yarn` - Install the required Node Packages using `yarn`
### Backend Development ### Backend Development
* Run `yarn build` to build the UI - Run `yarn build` to build the UI
* Open `Sonarr.sln` in Visual Studio - Open `Sonarr.sln` in Visual Studio
* Make sure `NzbDrone.Console` is set as the startup project - Make sure `NzbDrone.Console` is set as the startup project
* Build `NzbDrone.Windows` and `NzbDrone.Mono` projects - Build `NzbDrone.Windows` and `NzbDrone.Mono` projects
* Build Solution - Build Solution
### UI Development ### UI Development
* Run `yarn watch` to build UI and rebuild automatically when changes are detected - Run `yarn watch` to build UI and rebuild automatically when changes are detected
* Run Sonarr.Console.exe (or debug in Visual Studio) - Run Sonarr.Console.exe (or debug in Visual Studio)
### License ### Licenses
- [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html) - Copyright 2010-2020
* Copyright 2010-2019
### 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/)
* [TeamCity](http://www.jetbrains.com/teamcity/) - [TeamCity](http://www.jetbrains.com/teamcity/)