From f11cc851a76ab2f458ca29d9882fb83a15960386 Mon Sep 17 00:00:00 2001 From: Eduard Urbach Date: Mon, 2 Sep 2019 08:50:13 +0900 Subject: [PATCH] Added download step to installation --- README.md | 17 +++++++++++++---- README.src.md | 1 + 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dd99ae7a..6a4817e1 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,19 @@ [![Coverage][coverage-image]][coverage-url] [![Sponsor][sponsor-image]][sponsor-url] -## Prerequisites +## How to + +### Prerequisites * Install [Go](https://golang.org/) * Install [TypeScript](https://www.typescriptlang.org/) -## Installation +### Installation ```shell git clone https://github.com/animenotifier/notify.moe.git cd notify.moe +go mod download make tools make assets go build @@ -33,9 +36,11 @@ go build * Import the file `security/default/root.crt` as a trusted Root authority * Open `https://beta.notify.moe` -## What now? +### What now? -Take a look at [how to contribute](docs/contributing.md) to this project. +* Try the [example task for newcomers](docs/new-contributor-task.md). +* Make some changes and upload them to a new branch on your fork. +* Create a pull request on this repository. ## Find us @@ -44,6 +49,10 @@ Take a look at [how to contribute](docs/contributing.md) to this project. * [Twitter](https://twitter.com/animenotifier) * [GitHub](https://github.com/animenotifier/notify.moe) +## Contributing + +Please read [CONTRIBUTING.md](docs/contributing.md) for details on how to contribute to this project. + ## Statistics ![Uptime (30 days)](https://img.shields.io/uptimerobot/ratio/m777678498-177cb6b2990056768877bc2a.svg) diff --git a/README.src.md b/README.src.md index c2bcaca9..a3038856 100644 --- a/README.src.md +++ b/README.src.md @@ -14,6 +14,7 @@ ```shell git clone https://github.com/animenotifier/notify.moe.git cd notify.moe +go mod download make tools make assets go build