Did some changes

Modified the title, moved the documentation link to the top and modified the "How to install" and "How to update" sections.
This commit is contained in:
JeremyStar™ 2023-03-18 18:11:57 +01:00
parent 0e83bfd634
commit e3a8339a0d

View file

@ -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