From 281e7db7083d17806ca501f0e9d059837b1e121b Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Tue, 15 Oct 2024 13:51:02 +0200 Subject: [PATCH] Update documentation --- docs/docs/getting-started/initializing.md | 2 +- docs/docs/getting-started/installing.mdx | 70 +++++++++++++++++------ docs/docs/javadoc.md | 10 ++++ docs/docs/welcome.md | 5 +- 4 files changed, 68 insertions(+), 19 deletions(-) diff --git a/docs/docs/getting-started/initializing.md b/docs/docs/getting-started/initializing.md index 44b7e7a9..f8f946fc 100644 --- a/docs/docs/getting-started/initializing.md +++ b/docs/docs/getting-started/initializing.md @@ -6,7 +6,7 @@ title: Initializing the engine # Initializing the engine To initialize the sos!engine, simply add this to the initialization code of your application: ```java -new Engine(); +Engine.initialize(); ``` This is enough to initialize the engine and all installed subsystems. No need to manually initialize them. diff --git a/docs/docs/getting-started/installing.mdx b/docs/docs/getting-started/installing.mdx index 0821ddf5..c4edf4bc 100644 --- a/docs/docs/getting-started/installing.mdx +++ b/docs/docs/getting-started/installing.mdx @@ -12,16 +12,16 @@ import TabItem from '@theme/TabItem'; ## Gradle Add StarOpenSource's maven repository to your `build.gradle` file first: - + ```groovy repositories { mavenCentral() - // sos!engine's maven repository + // sos!engine maven repository maven { - name "staropensource-sosengine" url "https://mvn.staropensource.de/sosengine" + name "staropensource-engine" } } ``` @@ -31,10 +31,10 @@ repositories { repositories { mavenCentral() - // sos!engine's maven repository + // sos!engine maven repository maven { - name = "staropensource-sosengine" url = uri("https://mvn.staropensource.de/sosengine") + name = "staropensource-engine" } } ``` @@ -42,7 +42,7 @@ repositories { After that declare the engine as a dependency to your project in the `build.gradle` file: - + ```groovy dependencies { @@ -50,7 +50,12 @@ dependencies { implementation 'de.staropensource.engine:base:' + project.dependencyStarOpenSourceEngine // sos!engine subsystems - //implementation 'de.staropensource.engine:slf4j-compat:' + project.dependencyStarOpenSourceEngine // for SLF4J compatibility + //implementation 'de.staropensource.engine:ansi:' + project.dependencyStarOpenSourceEngine // nice logging and ANSI support in your application + //compileOnly 'de.staropensource.engine:ansi:' + project.dependencyStarOpenSourceEngine // nice logging only + //compileOnly 'de.staropensource.engine:slf4j-compat:' + project.dependencyStarOpenSourceEngine // SLF4J compatibility + //implementation 'de.staropensource.engine:windowing:' + project.dependencyStarOpenSourceEngine // creating and managing windows, requires a Windowing API implementation + //compileOnly 'de.staropensource.engine:glfw:' + project.dependencyStarOpenSourceEngine // Windowing API implementation using GLFW + //implementation 'de.staropensource.engine:notification:' + project.dependencyStarOpenSourceEngine // sending and receiving notifications inside your application } ``` @@ -61,7 +66,12 @@ dependencies { implementation("de.staropensource.engine:base:" + project.dependencyStarOpenSourceEngine) // sos!engine subsystems - //implementation("de.staropensource.engine:slf4j-compat:" + project.dependencyStarOpenSourceEngine) // for SLF4J compatibility + //implementation ("de.staropensource.engine:ansi:" + project.dependencyStarOpenSourceEngine) // nice logging and ANSI support in your application + //compileOnly ("de.staropensource.engine:ansi:" + project.dependencyStarOpenSourceEngine) // nice logging only + //compileOnly ("de.staropensource.engine:slf4j-compat:" + project.dependencyStarOpenSourceEngine) // SLF4J compatibility + //implementation ("de.staropensource.engine:windowing:' + project.dependencyStarOpenSourceEngine) // creating and managing windows, requires a Windowing API implementation + //compileOnly ("de.staropensource.engine:glfw:' + project.dependencyStarOpenSourceEngine) // Windowing API implementation using GLFW + //implementation ("de.staropensource.engine:notification:' + project.dependencyStarOpenSourceEngine) // sending and receiving notifications inside your application } ``` @@ -70,23 +80,23 @@ dependencies { ... and add this property to the `settings.gradle` file: ```properties # Set this to the engine version you want to use -dependencyStarOpenSourceEngine=1-alpha4 +dependencyStarOpenSourceEngine=1-alpha6 ``` ## Maven Add StarOpenSource's maven repository to your `pom.xml` file first: ```xml - + - staropensource-sosengine - StarOpenSource's sos!engine maven repository + staropensource-engine https://mvn.staropensource.de/sosengine + staropensource-engine ``` -After that declare the engine as a dependency to your project: +After that declare the engine as a dependency in your project: ```xml @@ -95,15 +105,43 @@ After that declare the engine as a dependency to your project: de.staropensource.engine base - 1-alpha0 + 1-alpha6 - + + + + diff --git a/docs/docs/javadoc.md b/docs/docs/javadoc.md index 689a78a6..d4d66de1 100644 --- a/docs/docs/javadoc.md +++ b/docs/docs/javadoc.md @@ -13,6 +13,7 @@ The engine API documentation covers the core engine and all official subsystems. - [slf4j-compat](https://jd.engine.staropensource.de/develop/slf4j-compat/) - [windowing](https://jd.engine.staropensource.de/develop/windowing/) - [windowing:glfw](https://jd.engine.staropensource.de/develop/windowing:glfw/) + - [notification](https://jd.engine.staropensource.de/develop/notification/) - v1-alpha0 - [All subsystems](https://jd.engine.staropensource.de/v1-alpha0/all/) - [base](https://jd.engine.staropensource.de/v1-alpha0/base/) @@ -57,3 +58,12 @@ The engine API documentation covers the core engine and all official subsystems. - [slf4j-compat](https://jd.engine.staropensource.de/v1-alpha5/slf4j-compat/) - [windowing](https://jd.engine.staropensource.de/v1-alpha5/windowing/) - [windowing:glfw](https://jd.engine.staropensource.de/v1-alpha5/windowing:glfw/) +- v1-alpha6 + - [All subsystem](https://jd.engine.staropensource.de/v1-alpha6/all/) + - [base](https://jd.engine.staropensource.de/v1-alpha6/base/) + - [testing](https://jd.engine.staropensource.de/v1-alpha6/testing/) + - [ansi](https://jd.engine.staropensource.de/v1-alpha6/ansi/) + - [slf4j-compat](https://jd.engine.staropensource.de/v1-alpha6/slf4j-compat/) + - [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/) diff --git a/docs/docs/welcome.md b/docs/docs/welcome.md index 08165e19..4be7a7b9 100644 --- a/docs/docs/welcome.md +++ b/docs/docs/welcome.md @@ -7,8 +7,8 @@ title: Welcome Welcome to the documentation for the StarOpenSource Engine! - + ## What is it? @@ -30,13 +30,14 @@ Subsystems on the other hand usually handle complex tasks. They provide abstract "But why are there so many of them?" you might ask. Good question! Subsystems are intended to [do one thing and do it well](https://en.wikipedia.org/wiki/Unix_philosophy). ## Available official subsystems -Besides the `base` engine, there is one stable subsystem, two experimental subsystems and one stub subsystem. +Besides the `base` engine, there are two stable subsystem and three experimental subsystems. ### Stable - [`ansi`](https://git.staropensource.de/StarOpenSource/Engine/src/branch/develop/ansi): Provides an ANSI logging implementation and a ShortcodeParserSkeleton implementation - [`slf4j-compat`](https://git.staropensource.de/StarOpenSource/Engine/src/branch/develop/slf4j-compat): Provides [SLF4J](https://slf4j.org/) compatibility logger that redirects all log calls to the engine. ### Experimental - [`windowing`](https://git.staropensource.de/StarOpenSource/Engine/src/branch/develop/windowing): Provides abstract APIs for creating and managing windows and monitors. - [`windowing-glfw`](https://git.staropensource.de/StarOpenSource/Engine/src/branch/develop/windowing/glfw): Windowing API, allowing GLFW to be used for creating windows and recieving input. +- [`notification`](https://git.staropensource.de/StarOpenSource/Engine/src/branch/develop/notification): Provides an API for sending and receiving notifications inside a program. ## API documentation To read the engine API documentation, visit [jd.engine.staropensource.de](https://jd.engine.staropensource.de).