Noah/NeuroDock
1
0
Fork 0
forked from Chat_things/NeuroDock
Code Pull Requests Activity

Updated README.md

Browse Source 
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
This commit is contained in:
Zacharias
2025-05-23 15:37:35 +02:00
parent 5c3efa1376
commit e7cedb7f08
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -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.<br>
## 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.<br>
- 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
- 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