Browse Source

docs: update README files with contribution guidelines and CI/CD info

Added contribution instructions, contact info, and CI/CD details to both README files.

Signed-off-by: longjin <longjin@DragonOS.org>


PR-URL: #1
fslongjin 3 weeks ago
parent
commit
90d970e8b0
2 changed files with 89 additions and 9 deletions
  1. 37 1
      README.md
  2. 52 8
      README_EN.md

+ 37 - 1
README.md

@@ -2,10 +2,17 @@
 
 这是一个用来下载deb包及其依赖项,并解压到指定文件夹的工具
 
+当前,DragonOS使用它来构建一些关键的包。
+
+## 发布包下载
+
+本项目使用[云原生构建cnb.cool](https://cnb.cool/)进行CI/CD, 并发布到[cnb cool release](https://cnb.cool/DragonOS-Community/deb-downloader/-/releases)。
+
+
 ## 安装
 
 ```
-make build-docker-ubuntu2204
+make build-docker-ubuntu2404
 ```
 
 ## 使用
@@ -31,3 +38,32 @@ make unpack
 ```
 make clean
 ```
+
+
+
+## 参与贡献
+
+您可以选择通过cnb.cool或者github PR进行贡献。
+
+### (推荐)在CNB.cool上贡献
+
+由于本项目的主仓库托管在cnb.cool上,因此我们推荐您通过CNB.cool的PR进行代码提交。
+
+仓库地址: https://cnb.cool/DragonOS-Community/deb-downloader
+
+### 在github上贡献
+
+如果您更喜欢使用github,请将您的修改推送到github上的对应分支,并发起一个PR。
+
+仓库地址: https://github.com/DragonOS-Community/deb-downloader
+
+> 由于仓库是从cnb.cool单向同步到github的,因此,
+> 一旦您在github上的PR被approve, maintainer将会手动为您在cnb.cool上创建一个PR,并把代码合并进去。
+>
+> (这有点麻烦,但请理解)
+
+## 联系我们
+
+如果您有任何问题或建议,请随时联系我们的[社区](https://bbs.dragonos.org.cn/)。
+
+本项目 Maintainer: <longjin@dragonos.org>

+ 52 - 8
README_EN.md

@@ -1,21 +1,65 @@
-# Deb Downloader
-This is a tool used for downloading .deb packages and their dependencies, and extracting them to a specified folder.
+# DEB Downloader
+
+This is a tool for downloading DEB packages along with their dependencies and extracting them to a specified directory.
+
+Currently, DragonOS uses it to build some critical packages.
+
+## Release Downloads
+
+This project uses [Cloud Native Build (cnb.cool)](https://cnb.cool/) for CI/CD, with releases published to [cnb.cool releases](https://cnb.cool/DragonOS-Community/deb-downloader/-/releases).
+
 ## Installation
+
 ```
-make build-docker-ubuntu2204
+make build-docker-ubuntu2404
 ```
+
 ## Usage
-### Download .deb Package and Its Dependencies
-Please replace `xxx` with the name of the .deb package you wish to download.
+
+### Download DEB Packages and Dependencies
+
+Replace `xxx` with the name of the DEB package you want to download.
+
 ```
 make PACKAGE_NAME=xxx download
 ```
-### Extract the .deb Package
-This command will extract the aforementioned .deb package into the `output/sysroot` folder.
+
+### Extract DEB Packages
+
+This command will extract the downloaded DEB packages to the `output/sysroot` directory.
+
 ```
 make unpack
 ```
-### Cleanup
+
+### Clean Up
+
 ```
 make clean
 ```
+
+## Contributing
+
+You can contribute either via cnb.cool or GitHub PR.
+
+### (Recommended) Contribute via CNB.cool
+
+Since the main repository is hosted on cnb.cool, we recommend submitting code via CNB.cool's PR system.
+
+Repository address: https://cnb.cool/DragonOS-Community/deb-downloader
+
+### Contribute via GitHub
+
+If you prefer using GitHub, please push your changes to the corresponding branch on GitHub and open a PR.
+
+Repository address: https://github.com/DragonOS-Community/deb-downloader
+
+> Note: The repository is synced one-way from cnb.cool to GitHub.  
+> Once your GitHub PR is approved, maintainers will manually create a PR on cnb.cool and merge the changes.  
+> (This process is slightly cumbersome, but we appreciate your understanding.)
+
+## Contact Us
+
+If you have any questions or suggestions, feel free to reach out to our [community](https://bbs.dragonos.org.cn/).
+
+Project Maintainer: <longjin@dragonos.org>