diff --git a/.documentation/JAVADOC-README.md b/.doc/JAVADOC-README.md similarity index 100% rename from .documentation/JAVADOC-README.md rename to .doc/JAVADOC-README.md diff --git a/.doc/README.md b/.doc/README.md new file mode 100644 index 0000000..402baed --- /dev/null +++ b/.doc/README.md @@ -0,0 +1,16 @@ +# 欢迎使用 EasyConfiguration ！ + +这个项目刚刚创建，详细的Javadoc与开发指南还在补充，请给我一点时间~ + + +## 基本定义 + +Value: 实际配置的单例值。 + +Manifest: 用于描述值基本配置的对象。 + +Provider: 用于提供配置文件的接口。 + +Wrapper: 用于包装配置文件的接口。 + +Initializer: 用于初始化的接口 diff --git a/.documentation/README.md b/.documentation/README.md deleted file mode 100644 index c34171f..0000000 --- a/.documentation/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# 欢迎使用 EasyConfiguration ！ - -这个项目刚刚创建，详细的Javadoc与开发指南还在补充，请给我一点时间~ diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 7b2557f..a66df15 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -41,7 +41,7 @@ jobs: rm -rf docs mkdir -vp docs cp -vrf core/target/apidocs/* docs/ - cp -vrf .documentation/JAVADOC-README.md docs/README.md + cp -vrf .doc/JAVADOC-README.md docs/README.md - name: "Generate the Javadoc sitemap" id: sitemap diff --git a/README.md b/README.md index f041e49..6369203 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,6 @@ -```text - ____ _____ ____ __ _ - / __/__ ____ __ __ / ___/__ ___ / _(_)__ ___ _________ _/ /_(_)__ ___ - / _// _ `(_-` 对象。 -- 支持通过注解规定配置对应的路径、注释等信息。 +## Advantages -## 开发 +- Class-based mechanism for initializing, loading, retrieving, and updating configuration files, ensuring convenience and efficiency. +- Supports manual serialization and deserialization of complex configurations. +- Offers multiple builder forms for rapid construction of `ConfigValue` objects. +- Enables specification of configuration paths, comments, and more via annotations. -详细开发介绍请 [点击这里](.documentation/README.md) , JavaDoc(最新Release) 请 [点击这里](https://CarmJos.github.io/EasyConfiguration) 。 +## Development -### 示例代码 +For a detailed development guide, [click here](.doc/README.md). For the latest JavaDoc release, [click here](https://CarmJos.github.io/EasyConfiguration). -您可以 [点击这里](demo/src/main/java/cc/carm/lib/configuration/demo/DatabaseConfiguration.java) 查看部分代码演示，更多演示详见 [开发介绍](.documentation/README.md) 。 +### Code Samples -### 依赖方式 +Check out some code demonstrations [here](demo/src/main/java/cc/carm/lib/configuration/demo/DatabaseConfiguration.java). For more examples, see the [development guide](.doc/README.md). -#### Maven 依赖 +### Dependencies + +#### Maven Dependency
-远程库配置 +Remote Repository Configuration ```xml - - + maven Maven Central https://repo1.maven.org/maven2 - + EasyConfiguration GitHub Packages https://maven.pkg.github.com/CarmJos/EasyConfiguration - - - carm-repo - Carm's Repo - https://repo.carm.cc/repository/maven-public/ - - ``` @@ -72,13 +62,12 @@
-通用原生依赖 +Generic Native Dependency ```xml - - + cc.carm.lib easyconfiguration-core @@ -86,7 +75,7 @@ compile - + cc.carm.lib easyconfiguration-yaml @@ -94,8 +83,7 @@ compile - - + cc.carm.lib easyconfiguration-json @@ -109,42 +97,39 @@
-#### Gradle 依赖 +#### Gradle Dependency
-远程库配置 +Remote Repository Configuration ```groovy repositories { - // 采用Maven中心库，安全稳定，但版本更新需要等待同步 + // Using Maven Central Repository for secure and stable updates, though synchronization might be needed. mavenCentral() - // 采用github依赖库，实时更新，但需要配置 (推荐) + // Using GitHub dependencies for real-time updates, configuration required (recommended). maven { url 'https://maven.pkg.github.com/CarmJos/EasyConfiguration' } - - // 采用我的私人依赖库，简单方便，但可能因为变故而无法使用 - maven { url 'https://repo.carm.cc/repository/maven-public/' } + } ```
-通用原生依赖 +Generic Native Dependency ```groovy dependencies { - //基础实现部分，需要自行实现“Provider”与“Wrapper”。 + // Basic implementation part, requiring custom implementation of “Provider” and “Wrapper”. api "cc.carm.lib:easyconfiguration-core:[LATEST RELEASE]" - //基于YAML文件的实现版本，可用于全部Java环境。 + // YAML file-based implementation, compatible with all Java environments. api "cc.carm.lib:easyconfiguration-yaml:[LATEST RELEASE]" - //基于JSON文件的实现版本，可用于全部Java环境。 - //需要注意的是，JSON不支持文件注释。 + // JSON file-based implementation, compatible with all Java environments. Note: JSON does not support file comments. api "cc.carm.lib:easyconfiguration-json:[LATEST RELEASE]" } @@ -152,23 +137,25 @@ dependencies {
-## 衍生项目 +## Derived Projects -### [**MineConfiguration**](https://github.com/CarmJos/MineConfiguration) (by @CarmJos ) +### [**MineConfiguration**](https://github.com/CarmJos/MineConfiguration) (by @CarmJos) EasyConfiguration for MineCraft! -开始在 MineCraft 相关服务器平台上轻松(做)配置吧！ +Easily manage configurations on MineCraft-related server platforms. -目前支持 BungeeCord, Bukkit(Spigot) 服务端，后续将支持更多平台。 +Currently supports BungeeCord, Bukkit (Spigot) servers, with more platforms to be supported soon. -## 支持与捐赠 +## Support and Donation -若您觉得本插件做的不错，您可以通过捐赠支持我！ +If you appreciate this plugin, consider supporting me with a donation! -感谢您对开源项目的支持！ +Thank you for supporting open-source projects! - +Many thanks to Jetbrains for kindly providing a license for us to work on this and other open-source projects. +[![](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://www.jetbrains.com/?from=https://github.com/ArtformGames/ResidenceList) -## 开源协议 -本项目源码采用 [GNU LESSER GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/lgpl-3.0.html) 开源协议。 +## Open Source License + +This project's source code is licensed under the [GNU LESSER GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/lgpl-3.0.html). diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 0000000..eb64cc8 --- /dev/null +++ b/README_CN.md @@ -0,0 +1,177 @@ +```text + ____ _____ ____ __ _ + / __/__ ____ __ __ / ___/__ ___ / _(_)__ ___ _________ _/ /_(_)__ ___ + / _// _ `(_-` 对象。 +- 支持通过注解规定配置对应的路径、注释等信息。 + +## 开发 + +详细开发介绍请 [点击这里](.doc/README.md) , JavaDoc(最新Release) 请 [点击这里](https://CarmJos.github.io/EasyConfiguration) 。 + +### 示例代码 + +您可以 [点击这里](demo/src/main/java/cc/carm/lib/configuration/demo/DatabaseConfiguration.java) 查看部分代码演示，更多演示详见 [开发介绍](.doc/README.md) 。 + +### 依赖方式 + +#### Maven 依赖 + +
+远程库配置 + +```xml + + + + + + + maven + Maven Central + https://repo1.maven.org/maven2 + + + + + EasyConfiguration + GitHub Packages + https://maven.pkg.github.com/CarmJos/EasyConfiguration + + + + + carm-repo + Carm's Repo + https://repo.carm.cc/repository/maven-public/ + + + + +``` + +
+ +
+通用原生依赖 + +```xml + + + + + + cc.carm.lib + easyconfiguration-core + [LATEST RELEASE] + compile + + + + + cc.carm.lib + easyconfiguration-yaml + [LATEST RELEASE] + compile + + + + + + cc.carm.lib + easyconfiguration-json + [LATEST RELEASE] + compile + + + + +``` + +
+ +#### Gradle 依赖 + +
+远程库配置 + +```groovy +repositories { + + // 采用Maven中心库，安全稳定，但版本更新需要等待同步 + mavenCentral() + + // 采用github依赖库，实时更新，但需要配置 (推荐) + maven { url 'https://maven.pkg.github.com/CarmJos/EasyConfiguration' } + + // 采用我的私人依赖库，简单方便，但可能因为变故而无法使用 + maven { url 'https://repo.carm.cc/repository/maven-public/' } +} +``` + +
+ +
+通用原生依赖 + +```groovy + +dependencies { + + //基础实现部分，需要自行实现“Provider”与“Wrapper”。 + api "cc.carm.lib:easyconfiguration-core:[LATEST RELEASE]" + + //基于YAML文件的实现版本，可用于全部Java环境。 + api "cc.carm.lib:easyconfiguration-yaml:[LATEST RELEASE]" + + //基于JSON文件的实现版本，可用于全部Java环境。 + //需要注意的是，JSON不支持文件注释。 + api "cc.carm.lib:easyconfiguration-json:[LATEST RELEASE]" + +} +``` + +
+ +## 衍生项目 + +### [**MineConfiguration**](https://github.com/CarmJos/MineConfiguration) (by @CarmJos ) + +EasyConfiguration for MineCraft! +开始在 MineCraft 相关服务器平台上轻松(做)配置吧！ + +目前支持 BungeeCord, Bukkit(Spigot) 服务端，后续将支持更多平台。 + +## 支持与捐赠 + +若您觉得本插件做的不错，您可以通过捐赠支持我！ + +感谢您对开源项目的支持！ + + + +万分感谢 Jetbrains 为我们提供了从事此项目和其他开源项目的许可！ +[![](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://www.jetbrains.com/?from=https://github.com/ArtformGames/ResidenceList) + +## 开源协议 + +本项目源码采用 [GNU LESSER GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/lgpl-3.0.html) 开源协议。