From 5cbb646bde3f3f520754c6e36e75d6f17ee1200d Mon Sep 17 00:00:00 2001 From: endernon Date: Mon, 27 May 2024 12:42:56 +0000 Subject: [PATCH] Update README.md --- README.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0dcce31..7f4b6ab 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A Server emulator for the game [`Honkai: Star Rail`](https://hsr.hoyoverse.com/e ![screenshot](https://git.xeondev.com/reversedrooms/FireflySR/raw/branch/master/screenshot.png) ...BUT I edited this text to make it easier to compile for goobers. -## I just want to run the server! I don't care about modifying the code. +# I just want to run the server! I don't care about modifying the code. - First, get [MongoDB](https://www.mongodb.com/try/download/community) - Go to [Reversedrooms FireflySR Releases Tab](https://git.xeondev.com/reversedrooms/FireflySR/releases) - On that page download "FireflySR-win64.zip". DO NOT DOWNLOAD SOURCE CODE!!! @@ -17,21 +17,15 @@ A Server emulator for the game [`Honkai: Star Rail`](https://hsr.hoyoverse.com/e -#### Requirements - +# I want to edit the code and build the project to how I like it! +First, get these prerequesites: - [Rust](https://www.rust-lang.org/tools/install) - [MongoDB](https://www.mongodb.com/try/download/community-edition) -- [Protobuf Compiler (protoc)](https://github.com/protocolbuffers/protobuf/releases/download/v26.1/protoc-26.1-win64.zip). You should manually extract it to somewhere and add `bin` subfolder to the system environment variable `PATH`. +- [Protobuf Compiler (protoc)](https://github.com/protocolbuffers/protobuf/releases/download/v26.1/protoc-26.1-win64.zip) (ONLY IF YOU ARE USING MICROSOFT WINDOWS). You should manually extract it to somewhere and add `bin` subfolder to the system environment variable `PATH`. Look online for how to add a folder to "path" #### Building -#### Using xtasks (recommended) -```sh -git clone https://git.xeondev.com/reversedrooms/FireflySR.git -cd FireflySR -cargo xtask run -``` ##### To run it with automatic recompilation when any Rust files are changed