From 67ef7ccd7a2aec754fd9b05203664c35676b51af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=80=97=E5=AD=90?= Date: Fri, 4 Aug 2023 02:23:54 +0800 Subject: [PATCH] feat: optimize readme --- README.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 63 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e6c27278..67358f34 100644 --- a/README.md +++ b/README.md @@ -6,30 +6,34 @@ [![Codecov](https://codecov.io/gh/haozi-team/panel/branch/main/graph/badge.svg?token=XFT5NGNSRG)](https://codecov.io/gh/haozi-team/panel) ![License](https://img.shields.io/github/license/haozi-team/panel) -这是耗子Linux面板的开源仓库，基于Apache License 2.0协议进行开源，目前处于积极开发状态。 +这是耗子Linux面板，一种使用GO开发的轻量Linux服务器运维管理面板。 -#### 交流QQ群：[12370907](https://jq.qq.com/?_wv=1027&k=I1oJKSTH) | QQ频道：[耗子](https://pd.qq.com/s/fyol46wfy) +#### 交流QQ群：[12370907](https://jq.qq.com/?_wv=1027&k=I1oJKSTH) | QQ频道：[pd.qq.com/s/fyol46wfy](https://pd.qq.com/s/fyol46wfy) 广告： [`WeAvatar` 多端多元化的统一头像服务](https://weavatar.com) ## 运行环境 -面板仅支持主流 `amd64` | `arm64` 系统的最新版本，且随着系统版本的更新，面板也会逐步停止对旧版本的支持。 +面板仅支持主流 `amd64` | `arm64` 系统的最新版本，且随着系统版本的更新，面板也会逐步停止对旧版本系统的支持。 -不支持 `Ubuntu`，因为其发版太频繁，难以维护。 +不支持 `Ubuntu`，因为其发版太过频繁，难以维护。 低配机器建议使用 `Debian`，资源占用较 `RHEL` 系更低。其他机器建议使用 `RockyLinux` | `AlmaLinux`，维护周期更长。 -不在下表中的其他同版本的 `RHEL` 系统（OpenCloudOS、Anolis、CentOS Stream等），可自行尝试安装，但不保证能够正常运行，且不提供技术支持。 +不在下表中的其他系统（OpenCloudOS、Anolis、CentOS Stream、Debian等），可自行尝试安装，但不保证能够正常运行，且不提供技术支持。 | 系统 | 版本 | |------------|----| +| RHEL | 9 | | RockyLinux | 9 | | AlmaLinux | 9 | | Debian | 12 | ## 安装面板 +安装面板前，你需要了解LNMP环境的基本知识，以及如何处理常见的LNMP环境问题，我们不建议**0基础**的用户安装和使用耗子Linux面板。 + +如果你决定继续，请以`root`用户登录服务器，执行以下命令安装面板： ```shell bash <(curl -sSL https://dl.cdn.haozi.net/panel/install_panel.sh) @@ -37,18 +41,34 @@ bash <(curl -sSL https://dl.cdn.haozi.net/panel/install_panel.sh) ## 日常维护 +使用`panel`命令进行日常维护： + ```shell panel ``` ## 问题反馈 -使用类问题，可在 [WePublish社区论坛](https://wepublish.cn/forums) 提问寻求帮助。 +使用类问题，可在 [WePublish社区论坛](https://wepublish.cn/forums) 提问或QQ群`@汤姆猫`寻求帮助。 -对于面板自身问题，可在 GitHub 的`Issues` +面板自身问题，可在 GitHub 的`Issues` 页面提交问题反馈，注意[提问的智慧](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)。 -交流QQ群：[12370907](https://jq.qq.com/?_wv=1027&k=I1oJKSTH) | QQ频道：[耗子](https://pd.qq.com/s/fyol46wfy) +## 贡献代码 + +### 寻找/创建 Issue + +您可以在 [Issue 列表](https://github.com/haozi-team/panel/issues) 中寻找或创建一个 Issue，留言表达想要处理该 Issue +的意愿，得到维护者的确认后，即可开始处理。 + +### 创建 PR + +- 如果您对该流程不太了解，可以查看[这篇文章](https://docs.github.com/en/get-started/quickstart/contributing-to-projects)； +- 在开发过程中，如果遇到问题可以随时在 Issue 中详尽描述该问题，以进一步沟通，但在此之前请确保自己已通过 Google + 等方式尽可能的尝试解决问题； +- 当 PR 开发完毕后，请为其添加 `🚀 Review Ready` 标签，维护者将及时进行评审； +- PR 合并后，如果描述设置正确，Issue 将被自动关闭； +- 我们非常欢迎您的贡献，将在下次发版时将您添加到首页贡献者中；❤️ ## 赞助商 @@ -72,6 +92,39 @@ panel #### 接受云资源和资金赞助，可通过QQ群咨询联系 -## Star 趋势 +## 行为准则 -[![Star 趋势](https://starchart.cc/haozi-team/panel.svg)](https://starchart.cc/haozi-team/panel) +耗子Linux面板遵守业界通用的行为准则。任何违反行为准则的行为都可以报告给我们： + +- 参与者将容忍反对意见。 +- 参与者必须确保他们的语言和行为没有人身攻击和贬低个人言论。 +- 在解释他人的言行时，参与者应始终保持良好的意图。 +- 不能容忍可合理视为骚扰的行为。 + +## 安全说明 + +安全性是我们最关心的问题之一，我们已在生产环境广泛应用耗子Linux面板。 + +耗子Linux面板采用业界多种方案尽可能保证面板的安全性，但是我们不能保证面板的绝对安全性，**因此我们不对面板的安全性做任何保证 +**。 + +如果您在使用面板的过程中发现任何安全问题，请勿提交 Issue，可通过以下方式直接联系我们： + +- 邮箱：i@haozi.net +- QQ：826896000 + +## 贡献者 + +这个项目的存在要归功于所有做出贡献的人，参与贡献请先查看贡献代码部分。 + + + +## Star 历史 + + + + + + Star History Chart + +