From e7cedb7f08f65ac91e95f11782fff960ff2a68e6 Mon Sep 17 00:00:00 2001 From: Zacharias Date: Fri, 23 May 2025 15:37:35 +0200 Subject: [PATCH] Updated README.md README.md - Added `MALAPITool` and `Launcher` under `How to build? And general information` sub header - Noted module dependencies for `API`, `Display`, `Launcher` - Added some general information to modules, pending some better general information - Added a specific sub header for clarity - Added a link to `MALAPITool` README --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 67f0dfe..2bfaa9b 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,16 @@ Launch options for AI_chat --api Provides API docs ``` -If you only want to build the `Display` or `API` module you can use the same command but replace `launcher` with the desire module.
+## How to build? And general information +If you only want to build a specific module, you can use the same command as listed in `How to run?` but replace `launcher` with the desire module.
- API: `$ ./gradlew :API:shadowJar` + - Depends on `Core` - Display: `$ ./gradlew :Display:shadowJar` + - Depends on `Core` and `MALAPITool` - Core: `$ ./gradlew :Core:shadowJar` - - However this one is kinda useless unless you want to directly implement the system into your application \ No newline at end of file + - However, this one is kinda useless unless you want to directly implement the system into your application +- MALAPITool: `$ ./gradlew :MALAPITool:shadowJar` + - Please read MALAPITool [README.md](https://server.4zellen.se:3000/Chat_things/chat_thing/src/branch/master/MALAPITool/README.md) +- Launcher: `$ ./gradlew :launcher:shadowJar` + - Depends on `API`, `Display` and `Core` + - This is the main module that runs the application and starts the API server \ No newline at end of file