From dba856281f10e3bdc24c3d246e46bdbbbb5a70da Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Tue, 11 Jun 2024 23:12:48 +0200 Subject: [PATCH] Update README --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8fd4280..cba7066 100644 --- a/README.md +++ b/README.md @@ -17,25 +17,25 @@ The StarOpenSource engine (or sos!engine for short) is a modular, extensible and ## About ### About the engine The sos!engine is a modular and extensible framework for building applications and games, written in the Java programming language. -The engine consists of various subsystems, each separate and responsible for only one thing. The engine also houses various useful utilities and classes making development fun, while being lightweight. +The engine consists of various subsystems, each separate and responsible for only one thing. The engine also houses various useful utilities and classes making development fun, and all that while being lightweight. ### About the repository -The sos!engine repository is a monorepo, consisting of the core engine, official subsystems and their documentation. +The sos!engine repository is a monorepo, consisting of [the core engine](https://git.staropensource.de/StarOpenSource/Engine/src/branch/develop/base), official subsystems and [their documentation](https://git.staropensource.de/StarOpenSource/Engine/src/branch/develop/docs). ### Priorities - modular - small & lightweight - fast -- [do one thing and do it well](https://en.wikipedia.org/wiki/Unix_philosophy) (subsystems) -- have as few dependencies as possible +- [do one thing and do it well](https://en.wikipedia.org/wiki/Unix_philosophy) (subsystems concept) +- have as few runtime dependencies as possible (note: we will cut down on some of them during development) ## Documentation -The official documentation for the StarOpenSource Engine is not yet available and won't be until we hit v1-rc0. +The official documentation for the StarOpenSource Engine is not yet available, but is planned. You can however [visit the Javadocs](https://jd.engine.staropensource.de). ## Contributing ### Requirements -You need the following things to be able to contribute to the StarOpenSource Engine: +You need the following things to be able to contribute code to the StarOpenSource Engine: - knowledge of Java -- (basic) knowledge of the engine +- knowledge about the internals of engine ### What IDE to use? We use and recommend using [IntelliJ IDEA Community Edition](https://github.com/JetBrains/intellij-community) for development because it is flexible, extendable, customizable, provides good completions and error detection. It's also open source. ### Code style @@ -48,4 +48,4 @@ Before creating a pull request, make sure you've - is compatible with other code in the monorepo, and - is compatible with other applications. If not, tell us in your pull request description. ### Making your first contribution -TODO (probably) until v1-rc0 +TODO (probably) until v1-alpha0