style(global): Added README for each module

This commit is contained in:
Zihlu Wang
2023-08-03 18:57:39 +08:00
parent 7c1082ca71
commit c53124bb61
8 changed files with 583 additions and 15 deletions
+19
View File
@@ -0,0 +1,19 @@
# Module `devkit-core`
## Introduction
This module is the main part of `JDevKit`, an open-source Java class library that provides a set of convenient tools to streamline code development and enhance productivity. This module serves as the basement of other modules.
## Prerequisites
This whole `JDevKit` is developed by **JDK 17**, which means you have to use JDK 17 for better experience.
## Installation
You don't have to install this module at all, any module which is from `JDevKit` contains this `devkit-core` module.
## Contact
If you have any suggestions, ideas, don't hesitate contacting us via [GitHub Issues](https://github.com/CodeCraftersCN/jdevkit/issues/new) or [Discord Community](https://discord.gg/NQK9tjcBB8).
If you face any bugs while using our library and you are able to fix any bugs in our library, we would be happy to accept pull requests from you on [GitHub](https://github.com/CodeCraftersCN/jdevkit/compare).