From e774dccb086b5e0267e02cc8465baacb9517a205 Mon Sep 17 00:00:00 2001 From: Eduard Urbach Date: Tue, 10 Sep 2019 09:31:55 +0900 Subject: [PATCH] Updated README --- README.md | 13 ++++++------- README.src.md | 13 ++++++------- 2 files changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 77d8b9a0..d2407d27 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,13 @@ [![Coverage][coverage-image]][coverage-url] [![Sponsor][sponsor-image]][sponsor-url] -## How to - -### Prerequisites +## Prerequisites +* Install [Linux](https://en.wikipedia.org/wiki/Linux), [MacOS](https://en.wikipedia.org/wiki/MacOS) or [WSL](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux) * Install [Go](https://golang.org/) * Install [TypeScript](https://www.typescriptlang.org/) -### Installation +## Installation ```shell git clone https://github.com/animenotifier/notify.moe.git @@ -26,18 +25,18 @@ make db ./notify.moe ``` -### Networking +## Networking * Add `beta.notify.moe 127.0.0.1` to your `hosts` file * Run `make ports` -### In your browser +## In your browser * Open the settings, search for certificates * Import the file `security/default/root.crt` as a trusted Root authority * Open `https://beta.notify.moe` -### What now? +## What now? * Try the [example task for newcomers](docs/new-contributor-task.md). * Make some changes and upload them to a new branch on your fork. diff --git a/README.src.md b/README.src.md index b465578b..56bfe447 100644 --- a/README.src.md +++ b/README.src.md @@ -2,14 +2,13 @@ {go:header} -## How to - -### Prerequisites +## Prerequisites +* Install [Linux](https://en.wikipedia.org/wiki/Linux), [MacOS](https://en.wikipedia.org/wiki/MacOS) or [WSL](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux) * Install [Go](https://golang.org/) * Install [TypeScript](https://www.typescriptlang.org/) -### Installation +## Installation ```shell git clone https://github.com/animenotifier/notify.moe.git @@ -22,18 +21,18 @@ make db ./notify.moe ``` -### Networking +## Networking * Add `beta.notify.moe 127.0.0.1` to your `hosts` file * Run `make ports` -### In your browser +## In your browser * Open the settings, search for certificates * Import the file `security/default/root.crt` as a trusted Root authority * Open `https://beta.notify.moe` -### What now? +## What now? * Try the [example task for newcomers](docs/new-contributor-task.md). * Make some changes and upload them to a new branch on your fork.