mirror of https://github.com/lidarr/Lidarr
Update README and CONTRIBUTING
This commit is contained in:
parent
8abff4a2bc
commit
73c5bb916e
|
@ -8,12 +8,12 @@ Setup guides, FAQ, the more information we have on the wiki the better.
|
|||
## Development ##
|
||||
|
||||
### Tools required ###
|
||||
- Visual Studio 2017 or higher (https://www.visualstudio.com/vs/). The community version is free and works (https://www.visualstudio.com/downloads/).
|
||||
- Visual Studio 2019 or higher (https://www.visualstudio.com/vs/). The community version is free and works (https://www.visualstudio.com/downloads/).
|
||||
- HTML/Javascript editor of choice (VS Code/Sublime Text/Webstorm/Atom/etc)
|
||||
- [Git](https://git-scm.com/downloads)
|
||||
- [NodeJS](https://nodejs.org/en/download/) (Node 8.X.X or higher)
|
||||
- [NodeJS](https://nodejs.org/en/download/) (Node 10.X.X or higher)
|
||||
- [Yarn](https://yarnpkg.com/)
|
||||
- .NET 4.6.2 or Mono equivalent.
|
||||
- .NET Core 3.1.
|
||||
|
||||
### Getting started ###
|
||||
|
||||
|
@ -22,7 +22,7 @@ Setup guides, FAQ, the more information we have on the wiki the better.
|
|||
3. Grab the submodules `git submodule init && git submodule update`
|
||||
4. Install the required Node Packages `yarn install`
|
||||
5. Start gulp to monitor your dev environment for any changes that need post processing using `yarn start` command.
|
||||
6. Build the project in Visual Studio, Setting startup project to `NZBDrone.Console`
|
||||
6. Build the project in Visual Studio, Setting startup project to `Lidarr.Console` and framework to `netcoreapp31`
|
||||
7. Debug the project in Visual Studio
|
||||
8. Open http://localhost:8686
|
||||
|
||||
|
@ -35,7 +35,7 @@ Setup guides, FAQ, the more information we have on the wiki the better.
|
|||
- Add tests (unit/integration)
|
||||
- Commit with *nix line endings for consistency (We checkout Windows and commit *nix)
|
||||
- One feature/bug fix per pull request to keep things clean and easy to understand
|
||||
- Use 4 spaces instead of tabs, this is the default for VS 2017 and WebStorm (to my knowledge)
|
||||
- Use 4 spaces instead of tabs, this is the default for VS 2019 and WebStorm (to my knowledge)
|
||||
|
||||
### Pull Requesting ###
|
||||
- Only make pull requests to develop, never master, if you make a PR to master we'll comment on it and close it
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
# Lidarr
|
||||
|
||||
[![Build Status](https://dev.azure.com/Lidarr/Lidarr/_apis/build/status/lidarr.Lidarr?branchName=develop)](https://dev.azure.com/Lidarr/Lidarr/_build/latest?definitionId=1&branchName=develop)
|
||||
[![BrowserStack Status](https://automate.browserstack.com/badge.svg?badge_key=Z1I4SVZOMitOdENIMHpkMlN3djJiRVJkTzBpdUJ5Q2ZtWVhnYTFvYS9qcz0tLTM5THJZRkVCZlk0blp5cXFBK1BDYWc9PQ==--67f41b00af03ab78148d3d711f22ca42ab348a52)](https://automate.browserstack.com/public-build/Z1I4SVZOMitOdENIMHpkMlN3djJiRVJkTzBpdUJ5Q2ZtWVhnYTFvYS9qcz0tLTM5THJZRkVCZlk0blp5cXFBK1BDYWc9PQ==--67f41b00af03ab78148d3d711f22ca42ab348a52)
|
||||
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/lidarr.svg)](https://github.com/lidarr/Lidarr/wiki/Docker)
|
||||
![Github Downloads](https://img.shields.io/github/downloads/lidarr/lidarr/total.svg)
|
||||
[![Backers on Open Collective](https://opencollective.com/lidarr/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/lidarr/sponsors/badge.svg)](#sponsors)
|
||||
|
@ -64,4 +63,4 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
|
|||
### License
|
||||
|
||||
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
|
||||
* Copyright 2010-2019
|
||||
* Copyright 2010-2020
|
||||
|
|
Loading…
Reference in New Issue