From 37ac235662247c29565327f5212466c4f51467a3 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Wed, 16 Oct 2024 13:09:53 +0200 Subject: [PATCH] Update versions and links in documentation --- docs/docs/getting-started/installing.mdx | 14 +++++++------- docs/docs/javadoc.md | 9 +++++++++ docs/docs/welcome.md | 2 +- 3 files changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/docs/getting-started/installing.mdx b/docs/docs/getting-started/installing.mdx index cbe78c2e..7799ea3d 100644 --- a/docs/docs/getting-started/installing.mdx +++ b/docs/docs/getting-started/installing.mdx @@ -80,7 +80,7 @@ dependencies { ... and add this property to the `settings.gradle` file: ```properties # Set this to the engine version you want to use -dependencyStarOpenSourceEngine=1-alpha6 +dependencyStarOpenSourceEngine=1-alpha7 ``` ## Maven @@ -105,7 +105,7 @@ After that declare the engine as a dependency in your project: de.staropensource.engine base - 1-alpha6 + 1-alpha7 @@ -113,35 +113,35 @@ After that declare the engine as a dependency in your project: de.staropensource.engine ansi - v1-alpha6 + 1-alpha7 --> diff --git a/docs/docs/javadoc.md b/docs/docs/javadoc.md index d4d66de1..9a3be9aa 100644 --- a/docs/docs/javadoc.md +++ b/docs/docs/javadoc.md @@ -67,3 +67,12 @@ The engine API documentation covers the core engine and all official subsystems. - [windowing](https://jd.engine.staropensource.de/v1-alpha6/windowing/) - [windowing:glfw](https://jd.engine.staropensource.de/v1-alpha6/windowing:glfw/) - [notification](https://jd.engine.staropensource.de/v1-alpha6/notification/) +- v1-alpha7 + - [All subsystem](https://jd.engine.staropensource.de/v1-alpha7/all/) + - [base](https://jd.engine.staropensource.de/v1-alpha7/base/) + - [testing](https://jd.engine.staropensource.de/v1-alpha7/testing/) + - [ansi](https://jd.engine.staropensource.de/v1-alpha7/ansi/) + - [slf4j-compat](https://jd.engine.staropensource.de/v1-alpha7/slf4j-compat/) + - [windowing](https://jd.engine.staropensource.de/v1-alpha7/windowing/) + - [windowing:glfw](https://jd.engine.staropensource.de/v1-alpha7/windowing:glfw/) + - [notification](https://jd.engine.staropensource.de/v1-alpha7/notification/) diff --git a/docs/docs/welcome.md b/docs/docs/welcome.md index 4be7a7b9..c0430f26 100644 --- a/docs/docs/welcome.md +++ b/docs/docs/welcome.md @@ -23,7 +23,7 @@ And I don't mean what you make within the bounds of the engine or framework, no, ## Architecture of the engine The engine consists of the core engine (`base` dependency in your project) and various subsystems (`slf4j-compat`, `windowing`, etc.). \ \ -The job of the base engine is to provide minimal classes and interfaces needed for an application. +The job of the base engine is to provide minimal classes and interfaces required for building a basic application. It contains among other things a default logger implementation, useful methods, event system and a placeholder system. \ \ Subsystems on the other hand usually handle complex tasks. They provide abstractions for libraries and operating system calls. \