JeremyStarTM/Engine
1
0
Fork 0
forked from StarOpenSource/Engine
Code Pull requests Activity Actions

Update README

Browse source
This commit is contained in:
JeremyStar™ 2024-06-11 23:12:48 +02:00
parent 306c2cd6a6
commit dba856281f
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -17,25 +17,25 @@ The StarOpenSource engine (or sos!engine for short) is a modular, extensible and
## About ## About
### About the engine ### About the engine
The sos!engine is a modular and extensible framework for building applications and games, written in the Java programming language. 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 ### 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 ### Priorities
- modular - modular
- small & lightweight - small & lightweight
- fast - fast
- [do one thing and do it well](https://en.wikipedia.org/wiki/Unix_philosophy) (subsystems) - [do one thing and do it well](https://en.wikipedia.org/wiki/Unix_philosophy) (subsystems concept)
- have as few dependencies as possible - have as few runtime dependencies as possible (note: we will cut down on some of them during development)
## Documentation ## 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). You can however [visit the Javadocs](https://jd.engine.staropensource.de).
## Contributing ## Contributing
### Requirements ### 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 - knowledge of Java
- (basic) knowledge of the engine - knowledge about the internals of engine
### What IDE to use? ### 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. 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 ### 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 code in the monorepo, and
- is compatible with other applications. If not, tell us in your pull request description. - is compatible with other applications. If not, tell us in your pull request description.
### Making your first contribution ### Making your first contribution
TODO (probably) until v1-rc0 TODO (probably) until v1-alpha0