Skip to content

docs: 重写 README#19

Merged
aba2222 merged 2 commits into
aba2222:mainfrom
xiokuai:docs/improve-readme
Feb 23, 2026
Merged

docs: 重写 README#19
aba2222 merged 2 commits into
aba2222:mainfrom
xiokuai:docs/improve-readme

Conversation

@xiokuai
Copy link
Copy Markdown
Contributor

@xiokuai xiokuai commented Feb 20, 2026

Summary

  • 重写 README,添加 shields.io 徽章(Python、Django、Bootstrap、AGPL-3.0)
  • 补充功能特性、技术栈说明
  • 添加虚拟环境部署教程(推荐)、Docker 部署、生产环境部署指南
  • 添加 API 文档(帖子列表、帖子详情接口及响应示例)
  • 添加环境变量说明

@aba2222
Copy link
Copy Markdown
Owner

aba2222 commented Feb 21, 2026

我更倾向于使用英语README。大多数仓库都是这样的。但可以将中文文档放在另一位置。

@xiokuai
Copy link
Copy Markdown
Contributor Author

xiokuai commented Feb 23, 2026

我将重写readme并将目前这一版本改为readme_cn以方便国人阅读

根据 review 反馈,将 README 改为英文,中文文档保留为 README_CN.md。
@aba2222 aba2222 merged commit 3341905 into aba2222:main Feb 23, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants