HighCapable/SweetDependency
5
0
Fork 0
mirror of https://github.com/HighCapable/SweetDependency.git synced 2025-12-08 14:43:49 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update README

Browse Source
This commit is contained in:
fankesyooni
2025-11-17 10:16:53 +08:00
parent 16f8422424
commit 84cc13e3a9
2 changed files with 28 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README-zh-CN.md
View File

@@ -12,10 +12,22 @@
[English](README.md) | 简体中文
| <img src="https://github.com/HighCapable/.github/blob/main/img-src/logo.jpg?raw=true" width = "30" height = "30" alt="LOGO"/> | [HighCapable](https://github.com/HighCapable) |
|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
| ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
这个项目属于上述组织，**点击上方链接关注这个组织**，发现更多好项目。
## 项目停止维护的说明
由于个人时间和精力有限，且目前 Gradle 官方已有更好的依赖管理方案：Version Catalog，本项目将停止维护。
这个问题我想了很久，因为 Gradle 的版本目录已经非常成熟，且有 IDE 层面的支持和代码跳转支持，不需要再手写 TOML 配置文件，这对于配置文件是不是 YAML 格式已经不重要了，并且版本目录有第三方可以一键更新版本的插件，使用起来应该也非常方便，这样一看下来，`SweetDependency` 的优势就不明显了，我觉得这个项目陪我走过的三年，是很美好的，因为它确实解决了我的项目版本管理的关键问题，也为其他有同样需求的开发者提供了帮助。
这个项目有着很多黑盒问题和早年一些我很不成熟的想法，已被标记为**屎山**或者**代码荒漠**，所有代码仅供学习参考，请勿用于生产环境。
最后说一点遗憾，IDEA 插件由于种种原因没写出来，而且我想了一下写出来我可能也大概率没精力维护，我不想把自己的精力浪费在一个不能给我带来生产价值的版本管理插件上了。
`SweetDependency` 不会再适配 Gradle 9.0.0 及以后的版本，就到这里了，这个仓库不会归档，我想是的，我会一直把它留在这里，如果你希望接手这个项目并继续维护，你可以 fork 本仓库并在 README 中注明此事宜，感谢你的支持。
## 这是什么
这是一个用来管理 Gradle 依赖的 Gradle 插件，所有依赖集中管理并自动更新，解决了每个子项目都需要手动更新到相同版本依赖的问题。
@@ -28,7 +40,7 @@
不仅仅是 Android 项目，任何使用 Gradle 作为构建工具的项目都可以使用。
目前暂时只有 Gradle 插件，IDEA 的相关插件还在计划开发中，预计将会支持配置文件的语法检查和将配置文件显示在 Android 项目的 Gradle 文件列表中。
目前暂时只有 Gradle 插件，~~IDEA 的相关插件还在计划开发中~~，预计将会支持配置文件的语法检查和将配置文件显示在 Android 项目的 Gradle 文件列表中。
支持 Gradle `7.x.x` 和 `8.x.x`，其它版本未做测试并不推荐使用。

16
README.md
View File

@@ -12,10 +12,22 @@ An easy autowire and manage dependencies Gradle plugin.
English | [简体中文](README-zh-CN.md)
| <img src="https://github.com/HighCapable/.github/blob/main/img-src/logo.jpg?raw=true" width = "30" height = "30" alt="LOGO"/> | [HighCapable](https://github.com/HighCapable) |
|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
| ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
This project belongs to the above-mentioned organization, **click the link above to follow this organization** and discover more good projects.
## Notice About Project Maintenance Status
Due to personal time and energy constraints, and considering that Gradle now officially provides a more mature dependency management solution through Version Catalog, this project will no longer receive active maintenance.
I've given this considerable thought. Gradle's Version Catalog has evolved into a well-established solution with comprehensive IDE support and code navigation capabilities, eliminating the need to manually write TOML configuration files. At this stage, whether dependencies are configured in YAML format has become less significant, especially given that Version Catalog benefits from third-party plugins offering one-click version updates, making it quite convenient to work with. When viewed from this perspective, `SweetDependency`'s advantages have become less distinctive. I treasure the three years this project has accompanied me – it successfully addressed my critical needs for project version management and helped other developers facing similar challenges.
This project carries some technical debt and early design decisions that I now recognize as immature. The codebase is provided as-is for learning and reference purposes only, and should not be used in production environments.
One regret I'd like to mention: the IDEA plugin wasn't completed due to various circumstances, and upon reflection, maintaining it would likely have proven challenging. I prefer not to invest my energy in a version management plugin that wouldn't deliver practical value to my work.
`SweetDependency` will not be adapted for Gradle 9.0.0 and later versions. This is where the journey ends. However, this repository will remain accessible rather than being archived – I'd like to keep it here. If you're interested in taking over this project and continuing its development, you're welcome to fork this repository and document this in your README. Thank you for your support.
## What's this
This is a Gradle plugin for managing Gradle dependencies.
@@ -29,7 +41,7 @@ which is relatively readable, and the configuration process is simple and easy t
Not just Android projects, any project that uses Gradle as a build tool will work.
Currently there is only Gradle plugin, IDEA related plugins are still under development,
Currently there is only Gradle plugin, ~~IDEA related plugins are still under development~~,
support for syntax checking of configuration file and displaying configuration file in the Android project's Gradle files list is expected.
Gradle `7.x.x` and `8.x.x` are supported, other versions have not been tested and are not recommended.