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

Update readme with new requirements for v3

This commit is contained in:
Mark McDowall 2019-03-16 15:25:03 -07:00
parent 06b876cf8b
commit 1b0c6b919f
1 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -20,33 +20,38 @@ Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS fee
### Requirements ### Requirements
* Visual Studio 2015 (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/)
### 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/en/articles/working-with-forks)
* 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 `yarn`
* 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.* ### Backend Development
### Development * Run `yarn build` to build the UI
* Open `Sonarr.sln` in Visual Studio
* Make sure `Sonarr.Console` is set as the startup project
* Build `Sonarr.Windows` and `Sonarr.Mono` projects
* Build Solution
* Open `NzbDrone.sln` in Visual Studio ### UI Development
* Make sure `NzbDrone.Console` is set as the startup project
* Run `yarn watch` to build UI and rebuild automatically when changes are detected
* Run Sonarr.Console.exe (or debug in Visual Studio)
### License ### License
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html) * [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
* Copyright 2010-2017 * 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/)
* [WebStorm](http://www.jetbrains.com/webstorm/)
* [TeamCity](http://www.jetbrains.com/teamcity/) * [TeamCity](http://www.jetbrains.com/teamcity/)