From 4ecd7eaf083b8a6cebeae1b7e14aab2bb1d16dcc Mon Sep 17 00:00:00 2001 From: Qstick Date: Sun, 6 Sep 2020 21:47:08 -0400 Subject: [PATCH] Update README and CONTRIBUTING Signed-off-by: Robin Dadswell --- CONTRIBUTING.md | 11 ++++++----- README.md | 1 + 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12f9e172d..913b134af 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,11 +19,12 @@ Setup guides, FAQ, the more information we have on the [wiki](https://wiki.serva 1. Fork Readarr 2. Clone the repository into your development machine. [*info*](https://help.github.com/articles/working-with-repositories) -3. Install the required Node Packages `yarn install` -4. Start gulp to monitor your dev environment for any changes that need post processing using `yarn start` command. -5. Build the project in Visual Studio, Setting startup project to `Readarr.Console` and framework to `netcoreapp31` -6. Debug the project in Visual Studio -7. Open http://localhost:8787 +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 `Readarr.Console` and framework to `netcoreapp31` +7. Debug the project in Visual Studio +8. Open http://localhost:8787 ### Contributing Code ### - If you're adding a new, already requested feature, please comment on [Github Issues](https://github.com/Readarr/Readarr/issues "Github Issues") so work is not duplicated (If you want to add something not already on there, please talk to us first) diff --git a/README.md b/README.md index 43859b521..f1835fa9b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![Build Status](https://dev.azure.com/Readarr/Readarr/_apis/build/status/Readarr.Readarr?branchName=develop)](https://dev.azure.com/Readarr/Readarr/_build/latest?definitionId=1&branchName=develop) [![Docker Pulls](https://img.shields.io/docker/pulls/hotio/readarr)](https://hub.docker.com/r/hotio/readarr) +![Github Downloads](https://img.shields.io/github/downloads/readarr/readarr/total.svg) [![Backers on Open Collective](https://opencollective.com/readarr/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/readarr/sponsors/badge.svg)](#sponsors) ### Readarr is in early stages of development, alpha/beta binary builds are not yet available. Use of any test builds isn't recommend, and may have detrimental effects on your library.