diff --git a/README.md b/README.md index d03c2c48d..4de1c7db7 100644 --- a/README.md +++ b/README.md @@ -7,24 +7,6 @@ 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. -* 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)) - -## Planned Features: - -* Scanning PreDB to know when a new release is available. -* Fixing the other Indexers and download clients. -* Importing of Sonarr config. - ## Download Release builds can be found on: @@ -38,9 +20,27 @@ Docker containers from [linuxserver.io](http://tools.linuxserver.io/dockers) can * [armhf](https://store.docker.com/community/images/lsioarmhf/radarr) * [aarch64](https://store.docker.com/community/images/lsioarmhf/radarr-aarch64) -To connect to the UI, fire up your browser and open http://localhost:7878 or http://your-ip:7878. +To connect to the UI, fire up your browser and open or . + +## Currently Working + +* Adding new movies +* Manually searching for releases of movies +* Automatically searching for releases +* 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)) + +## Planned Features + +* Scanning PreDB to know when a new release is available +* Fixing the other Indexers and download clients +* Importing of Sonarr config -## Major Features Include: +## Major Features * 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* @@ -50,27 +50,27 @@ To connect to the UI, fire up your browser and open http://localhost:7878 or htt * 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 +* [Visual Studio Community](https://www.visualstudio.com/vs/community/) or [MonoDevelop](http://www.monodevelop.com) * [Git](https://git-scm.com/downloads) -* [NodeJS](https://nodejs.org/download/) +* [Node.js](https://nodejs.org/en/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) +* Make sure all the required software mentioned above are installed +* Clone the repository into your development machine ([*info*](https://help.github.com/desktop/guides/contributing/working-with-your-remote-repository-on-github-or-github-enterprise/)) * 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.* +*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. +* 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 @@ -80,7 +80,7 @@ To connect to the UI, fire up your browser and open http://localhost:7878 or htt ### 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)