open-source-mirrors
/
Readarr
mirror of https://github.com/Readarr/Readarr
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update readme.md

Browse Source
pull/6/head
Keivan Beigi 10 years ago
parent f1f7c2b699
commit 412db12f67
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File

21
readme.md
Unescape View File

@ -9,9 +9,11 @@ NZBDrone is a PVR for newsgroup users. It can monitor multiple RSS feeds for new
* Automatically detects new episodes * Automatically detects new episodes
* can scan your existing library and then download any old seasons that are missing * can scan your existing library and then download any old seasons that are missing
* can watch for better versions and upgrade your existing episodes. *eg. from DVD to Blu-Ray* * can watch for better versions and upgrade your existing episodes. *eg. from DVD to Blu-Ray*
* automatic failed download handling
* manual search so you can pick any release or to see why a release was rejected
* fully configurable episode renaming * fully configurable episode renaming
* full integration with SABNzbd * full integration with SABNzbd and NzbGet
* full integration with XBMC (notification, library update, metadata) * full integration with XBMC,Plex (notification, library update, metadata)
* full support for specials and multi-episode releases * full support for specials and multi-episode releases
* beautiful UI * beautiful UI
@ -19,29 +21,30 @@ NZBDrone is a PVR for newsgroup users. It can monitor multiple RSS feeds for new
## Configuring Development Enviroment: ## ## Configuring Development Enviroment: ##
### Requirements ### ### Requirements ###
- Visual Studio 2012 ([Express Edition](http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-for-web "Express Edition") might work but not tested.) - Visual Studio 2013 ([Express Edition](http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-for-web "Express Edition") might work but not tested.)
- [Git](http://git-scm.com/downloads) - [Git](http://git-scm.com/downloads)
- [NodeJS](http://nodejs.org/download/) - [NodeJS](http://nodejs.org/download/)
- [Grunt](http://gruntjs.com/getting-started) - [Gulp](http://gulpjs.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/articles/working-with-repositories) - Clone the repository into your development machine. [*info*](https://help.github.com/articles/working-with-repositories)
- install the required Node Packages using the following command `npm install` - install the required Node Packages `npm install`
- start grunt to monitor your dev environment for any changes that need post processing using `grunt` command. - install gulp `npm install gulp -g`
- start gulp to monitor your dev environment for any changes that need post processing using `gulp watch` command.
*Please note grunt must be running at all times while you are working with NzbDrone source files.* *Please note gulp must be running at all times while you are working with NzbDrone client source files.*
### Development ### ### Development ###
- Open `NzbDrone.sln` in Visual Studio 2012 - 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-2013 Copyright 2010-2014
### Sponsors ### ### Sponsors ###

Write Preview
Loading…
Cancel
Save