From e3a8339a0d9d41c4b74ba132c7ad6f796f61bab3 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Sat, 18 Mar 2023 18:11:57 +0100 Subject: [PATCH] Did some changes Modified the title, moved the documentation link to the top and modified the "How to install" and "How to update" sections. --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d3fbe6a..62ec477 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ -# CORE +# StarOpenSource CORE (aka. SOSCORE aka. CORE) CORE is a framework that simplifies development for games and applications made in Godot 4. +# Documentaton +[You can access the documentation by clicking this text.](https://git.staropensource.de/StarOpenSource/core/wiki) + # For whom is it useful? CORE is only useful for new projects. Started projects could break because CORE has certain requirements that must be met. @@ -12,6 +15,7 @@ CORE is only useful for new projects. Started projects could break because CORE # How to install - Clone CORE into your project root using `git clone https://git.staropensource.de/StarOpenSource/core.git CORE` +- Remove any autoload singletons - Add three scripts to your autoload: | Name | Path | | ------------ | -------------------------- | @@ -19,9 +23,9 @@ CORE is only useful for new projects. Started projects could break because CORE | Logger | res://CORE/logger.gd | | Preprocessor | res://CORE/preprocessor.gd | - Select res://CORE/background.tscn as your startup scene +- [Follow the post-installation guide](https://git.staropensource.de/StarOpenSource/core/wiki/Using-CORE) # How to update +- Close your project - Pull new changes using `git pull` - -# Documentation -[The CORE documentation is available in the wiki.](https://git.staropensource.de/StarOpenSource/core/wiki) +- Reopen your project