mirror of
https://github.com/Sonarr/Sonarr
synced 2024-12-22 07:43:01 +00:00
Update docs
- Fix project names - Unify dev environment setup
This commit is contained in:
parent
bf86b09f4e
commit
35f28bdc71
2 changed files with 3 additions and 17 deletions
|
@ -7,21 +7,7 @@ Setup guides, FAQ, the more information we have on the wiki the better.
|
||||||
|
|
||||||
## Development ##
|
## Development ##
|
||||||
|
|
||||||
### Tools required ###
|
See the readme for information on setting up your development environment.
|
||||||
- Visual Studio 2015
|
|
||||||
- HTML/Javascript editor of choice (Sublime Text/Webstorm/Atom/etc)
|
|
||||||
- npm (node package manager)
|
|
||||||
- git
|
|
||||||
|
|
||||||
### Getting started ###
|
|
||||||
|
|
||||||
1. Fork Sonarr
|
|
||||||
2. Clone (develop branch) *you may need pull in submodules separately if you client doesn't clone them automatically (CurlSharp)*
|
|
||||||
3. Run `npm install`
|
|
||||||
4. Run `npm start` - Used to compile the UI components and copy them.
|
|
||||||
Leave this window open.
|
|
||||||
If you have gulp globally installed you can use `gulp watch` instead
|
|
||||||
5. Compile in Visual Studio
|
|
||||||
|
|
||||||
### Contributing Code ###
|
### Contributing Code ###
|
||||||
- If you're adding a new, already requested feature, please comment on [Github Issues](https://github.com/Sonarr/Sonarr/issues "Github Issues") so work is not duplicated (If you want to add something not already on there, please talk to us first)
|
- If you're adding a new, already requested feature, please comment on [Github Issues](https://github.com/Sonarr/Sonarr/issues "Github Issues") so work is not duplicated (If you want to add something not already on there, please talk to us first)
|
||||||
|
|
|
@ -36,8 +36,8 @@ Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS fee
|
||||||
|
|
||||||
* 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 `Sonarr.Console` is set as the startup project
|
* Make sure `NzbDrone.Console` is set as the startup project
|
||||||
* Build `Sonarr.Windows` and `Sonarr.Mono` projects
|
* Build `NzbDrone.Windows` and `NzbDrone.Mono` projects
|
||||||
* Build Solution
|
* Build Solution
|
||||||
|
|
||||||
### UI Development
|
### UI Development
|
||||||
|
|
Loading…
Reference in a new issue