From 75a803f1a25c1d81665a3b726058b705ac6f3fe3 Mon Sep 17 00:00:00 2001 From: Evotushon Date: Mon, 24 Apr 2023 16:26:56 +0200 Subject: [PATCH] Make README.md adequate to Markdown Style Standards --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f9b5ecfd7..24712e426 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,29 @@ # Erupe Community Edition + ## Setup + If you are only looking to install Erupe, please use [a pre-compiled binary](https://github.com/ZeruLight/Erupe/releases/latest). If you want to modify or compile Erupe yourself, please read on. + ### Requirements + - [Go](https://go.dev/dl/) - [PostgreSQL](https://www.postgresql.org/download/) + ### Installation + 1. Bring up a fresh database by using the [backup file attached with the latest release](https://github.com/ZeruLight/Erupe/releases/latest/download/SCHEMA.sql). 2. Run each script under [patch-schema](./patch-schema) as they introduce newer schema. 3. Edit [config.json](./config.json) such that the database password matches your PostgreSQL setup. 4. Run `go build` or `go run .` to compile Erupe. + ### Note + - You will need to acquire and install the client files and quest binaries separately. -# Resources + +## Resources + - [Quest and Scenario Binary Files](https://files.catbox.moe/xf0l7w.7z) - [PewPewDojo Discord](https://discord.gg/CFnzbhQ) -- [Community FAQ Pastebin](https://pastebin.com/QqAwZSTC) \ No newline at end of file +- [Community FAQ Pastebin](https://pastebin.com/QqAwZSTC)ter