From ef613acc594c8ac36f92a06c856b4f309869d590 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Tue, 20 Aug 2024 20:54:02 +0200 Subject: [PATCH] [no ci] Fix typos, add link for JVM langs --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e68870af..09ed93ec 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ The StarOpenSource Engine is under heavy development and is extremely unstable. ## About ### ... the engine -The StarOpenSource 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 a few closely-related things. +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 tasks. \ Not only that. The engine also features various useful classes, interfaces and methods making development fun and simpler, while being lightweight. ### ... 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. Here's a quick rundown on the most important things: - 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). - 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. - Use your brain. ### Pull request guidelines