From b3dfb960b55fa474407f1bd32a78ef22aa20f05f Mon Sep 17 00:00:00 2001 From: Mitchell Cash Date: Sun, 15 Jan 2017 08:23:35 +1000 Subject: [PATCH] Cleanup README --- readme.md => README.md | 66 ++++++++++++++++++++++-------------------- 1 file changed, 35 insertions(+), 31 deletions(-) rename readme.md => README.md (66%) diff --git a/readme.md b/README.md similarity index 66% rename from readme.md rename to README.md index 86665c6fd..34e021d27 100644 --- a/readme.md +++ b/README.md @@ -8,6 +8,7 @@ This fork of Sonarr aims to turn it into something like Couchpotato. ## Currently working: + * Adding new movies * Manually searching for releases of movies. * Automatically searching for releases. @@ -19,65 +20,68 @@ This fork of Sonarr aims to turn it into something like Couchpotato. * New TorrentPotato Indexer (Works well with [Jackett](https://github.com/Jackett/Jackett)) ## Planned Features: + * Scanning PreDB to know when a new release is available. * Fixing the other Indexers and download clients. * Importing of Sonarr config. ## Download + 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. Docker containers from [linuxserver.io](https://linuxserver.io) can be found here. -* [Radarr (x64)](https://hub.docker.com/r/linuxserver/radarr/) -* [Radarr (armhf)](https://hub.docker.com/r/lsioarmhf/radarr/) -* [Radarr (aarch64)](https://hub.docker.com/r/lsioarmhf/radarr-aarch64/) +* [Radarr (x64)](https://hub.docker.com/r/linuxserver/radarr/) +* [Radarr (armhf)](https://hub.docker.com/r/lsioarmhf/radarr/) +* [Radarr (aarch64)](https://hub.docker.com/r/lsioarmhf/radarr-aarch64/) 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) -## Major Features Include: ## +## Major Features Include: -* Support for major platforms: Windows, Linux, OSX, Raspberry Pi, etc. -* Can watch for better quality of the movies you have and do an upgrade. +* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc. +* 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 -* 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). +* 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 Kodi, Plex (notification, library update, metadata) * And a beautiful UI -## Configuring Development Environment: ## +## Configuring Development Environment: -### 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/) +### Requirements -### 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. -- 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. +### Setup -*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 ### -- 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 +### 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 + +### License -### License ### * [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 - - [ReSharper](http://www.jetbrains.com/resharper/) - - [WebStorm](http://www.jetbrains.com/webstorm/) - - [TeamCity](http://www.jetbrains.com/teamcity/) +* [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools + * [ReSharper](http://www.jetbrains.com/resharper/) + * [WebStorm](http://www.jetbrains.com/webstorm/) + * [TeamCity](http://www.jetbrains.com/teamcity/)