From 9b4d226de40bd8a56cf1180afbb7aef7b0237f9b Mon Sep 17 00:00:00 2001 From: GregF Date: Sat, 20 Apr 2024 17:57:05 +0000 Subject: [PATCH] Update README.md Add instructions for how to set up an environment for Zaros. Really just link to 2009Scape --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e57c50f..f0c4579 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ +# Zaros : All-in-one JSON editing + [![pipeline status](https://gitlab.com/2009scape/rs09-thanos-tool/badges/master/pipeline.svg)](https://gitlab.com/2009scape/rs09-thanos-tool/-/commits/master) -**Zaros : All-in-one JSON editing** - -This tool is capable of modifying every JSON file you're likely to need to modify inside of the 2009scape codebase. +This tool is capable of modifying every JSON file you're likely to need to modify inside of the 2009scape codebase (except music right now). This tool is intended only for developers of 2009scape. If you are running your own fork of the codebase please do not report your bugs to me. + +## Setup +Follow the guide on [2009Server](https://gitlab.com/2009scape/2009scape#content-developers-setting-up-the-project). Follow the whole guide so you can make a fork from 2009Scape and open MRs correctly. You do not need to fork Zaros if all you are doing is editing .jsons.