StarOpenSource/Engine
StarOpenSource/Engine
2
0
Fork 1
Code Issues 10 Pull requests Releases 9 Activity Actions

[no ci] Fix typos, add link for JVM langs

Browse source
This commit is contained in:
JeremyStar™ 2024-08-20 20:54:02 +02:00
parent 29ac99c478
commit ef613acc59
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -19,8 +19,8 @@ The StarOpenSource Engine is under heavy development and is extremely unstable.
## About ## About
### ... the engine ### ... the engine
The StarOpenSource Engine is a modular and extensible framework for building applications and games written in the Java programming language. The StarOpenSource Engine is a modular and extensible framework for building applications and games written in [one of the multiple JVM programming languages](https://en.wikipedia.org/wiki/List_of_JVM_languages).
The engine consists of various subsystems, each separate and responsible for only a few closely-related things. The engine consists of various subsystems, each separate and responsible for only a few closely-related tasks.
\ \
Not only that. The engine also features various useful classes, interfaces and methods making development fun and simpler, while being lightweight. Not only that. The engine also features various useful classes, interfaces and methods making development fun and simpler, while being lightweight.
### ... the repository ### ... the repository
@ -50,10 +50,10 @@ We recommend and are using [IntelliJ IDEA Community Edition](https://github.com/
We recommend looking at existing classes and code for a good understanding on how we'd like code to be written. We recommend looking at existing classes and code for a good understanding on how we'd like code to be written.
Here's a quick rundown on the most important things: Here's a quick rundown on the most important things:
- Document EVERYTHING. Every single class, field and method, even if private. - Document EVERYTHING. Every single class, field and method, even if private.
- Make comments about your code, unless it's extremly simple and easy to understand. - Make comments about your code, unless it's extremely simple and easy to understand.
- Make sure to add and update `@since` in javadoc comments (update if the javadoc changes a good amount). - Make sure to add and update `@since` in javadoc comments (update if the javadoc changes a good amount).
- Keep stuff simple, no need to elaborate what a logger is. Though remember to not make it *too* simple. - Keep stuff simple, no need to elaborate what a logger is. Though remember to not make it *too* simple.
- Make sure every field and method has a newline to seperate it. - Make sure every field and method has a newline to separate it.
- Files must end with a newline or cats might get angry. - Files must end with a newline or cats might get angry.
- Use your brain. - Use your brain.
### Pull request guidelines ### Pull request guidelines