Skip to content

Commit 6b594f6

Browse files
authored
Revise README.zh-cn.md for clarity and updates
Updated the README file to improve clarity and consistency in the project goals, usage instructions, and contribution guidelines. Signed-off-by: Paper Moon <[email protected]>
1 parent 2a6af15 commit 6b594f6

File tree

1 file changed

+58
-64
lines changed

1 file changed

+58
-64
lines changed

README.zh-cn.md

Lines changed: 58 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -13,100 +13,99 @@
1313

1414
[English](./README.md) | [繁體中文](./README.zh-tw.md)
1515

16-
## 目的
16+
## 项目目标
17+
本项目的核心目标,是让自建Git服务的过程,变得最简单、最高效、最省心。
1718

18-
这个项目的目标是提供最简单、最快速、最无痛的方式来设置自托管的 Git 服务
19+
Gitea基于Go语言开发,凡Go语言支持的平台与架构,它皆能适配,涵盖Linux、macOS、Windows系统,以及x86、amd64、ARM、PowerPC架构。项目自2016年11月从[Gogs](https://gogs.io) [分叉](https://blog.gitea.com/welcome-to-gitea/)而来,如今已是焕然一新
1920

20-
由于 Gitea 是用 Go 语言编写的,它可以在 Go 支持的所有平台和架构上运行,包括 Linux、macOS 和 Windows 的 x86、amd64、ARM 和 PowerPC 架构。这个项目自 2016 年 11 月从 [Gogs](https://gogs.io) [分叉](https://blog.gitea.com/welcome-to-gitea/) 而来,但已经有了很多变化。
21+
- 在线体验:访问[demo.gitea.com](https://demo.gitea.com)
22+
- 免费服务(仓库数量有限):访问[gitea.com](https://gitea.com/user/login)
23+
- 快速部署专属实例:前往[cloud.gitea.com](https://cloud.gitea.com)开启免费试用
2124

22-
在线演示可以访问 [demo.gitea.com](https://demo.gitea.com)
2325

24-
要访问免费的 Gitea 服务(有一定数量的仓库限制),可以访问 [gitea.com](https://gitea.com/user/login)
26+
## 官方文档
27+
你可在[官方文档网站](https://docs.gitea.com/)获取完整文档,内容涵盖安装部署、管理维护、使用指南、开发贡献等,助你快速上手并充分探索所有功能。
2528

26-
要快速部署您自己的专用 Gitea 实例,可以在 [cloud.gitea.com](https://cloud.gitea.com) 开始免费试用
29+
若有建议或想参与文档编写,可访问[文档仓库](https://gitea.com/gitea/docs)
2730

28-
## 文件
2931

30-
您可以在我们的官方 [文件网站](https://docs.gitea.com/) 上找到全面的文件。
32+
## 构建方法
33+
进入源码根目录,执行以下命令构建:
3134

32-
它包括安装、管理、使用、开发、贡献指南等,帮助您快速入门并有效地探索所有功能。
35+
```
36+
TAGS="bindata" make build
37+
```
3338

34-
如果您有任何建议或想要贡献,可以访问 [文件仓库](https://gitea.com/gitea/docs)
39+
若需支持SQLite数据库,执行:
3540

36-
## 构建
41+
```
42+
TAGS="bindata sqlite sqlite_unlock_notify" make build
43+
```
3744

38-
从源代码树的根目录运行
45+
`build`目标分为两个子目标
3946

40-
TAGS="bindata" make build
47+
- `make backend`:需依赖[Go Stable](https://go.dev/dl/),具体版本见[go.mod](/go.mod)
48+
- `make frontend`:需依赖[Node.js LTS](https://nodejs.org/en/download/)(及以上版本)和[pnpm](https://pnpm.io/installation)
4149

42-
如果需要 SQLite 支持:
50+
构建需联网以下载Go和npm依赖包。若使用包含预构建前端文件的官方源码压缩包,无需触发`frontend`目标,无Node.js环境也可完成构建。
4351

44-
TAGS="bindata sqlite sqlite_unlock_notify" make build
52+
更多细节:[https://docs.gitea.com/installation/install-from-source](https://docs.gitea.com/installation/install-from-source)
4553

46-
`build` 目标分为两个子目标:
4754

48-
- `make backend` 需要 [Go Stable](https://go.dev/dl/),所需版本在 [go.mod](/go.mod) 中定义。
49-
- `make frontend` 需要 [Node.js LTS](https://nodejs.org/en/download/) 或更高版本。
55+
## 使用方法
56+
构建完成后,源码根目录默认生成`gitea`可执行文件,运行命令:
5057

51-
需要互联网连接来下载 go 和 npm 模块。从包含预构建前端文件的官方源代码压缩包构建时,不会触发 `frontend` 目标,因此可以在没有 Node.js 的情况下构建。
58+
```
59+
./gitea web
60+
```
5261

53-
更多信息:https://docs.gitea.com/installation/install-from-source
62+
> [!NOTE]
63+
> 若需调用API,我们已提供实验性支持,文档详见[此处](https://docs.gitea.com/api)
5464
55-
## 使用
5665

57-
构建后,默认情况下会在源代码树的根目录生成一个名为 `gitea` 的二进制文件。要运行它,请使用:
66+
## 贡献指南
67+
标准流程:Fork → Patch → Push → Pull Request
5868

59-
./gitea web
69+
> [!NOTE]
70+
> 1. 提交Pull Request前,务必阅读[《贡献者指南》](CONTRIBUTING.md)
71+
> 2. 若发现项目漏洞,请通过邮件**[email protected]**私信反馈,感谢你的严谨!
6072
61-
> [!注意]
62-
> 如果您对使用我们的 API 感兴趣,我们提供了实验性支持,并附有 [文件](https://docs.gitea.com/api)
6373

64-
## 贡献
74+
## 多语言翻译
75+
翻译工作通过[Crowdin](https://translate.gitea.com)进行。若需新增翻译语言,可联系Crowdin项目管理员添加;也可提交issue申请,或在Discord的#translation频道咨询。
6576

66-
预期的工作流程是:Fork -> Patch -> Push -> Pull Request
77+
若需翻译上下文或发现翻译问题,可在对应文本下留言或通过Discord沟通。文档设有翻译相关专区(目前内容待补充),将根据问题逐步完善。
6778

68-
> [!注意]
69-
>
70-
> 1. **在开始进行 Pull Request 之前,您必须阅读 [贡献者指南](CONTRIBUTING.md)**
71-
> 2. 如果您在项目中发现了漏洞,请私下写信给 **[email protected]**。谢谢!
79+
更多信息:[翻译贡献文档](https://docs.gitea.com/contributing/localization)
7280

73-
## 翻译
7481

75-
[![Crowdin](https://badges.crowdin.net/gitea/localized.svg)](https://translate.gitea.com)
82+
## 官方及第三方项目
7683

77-
翻译通过 [Crowdin](https://translate.gitea.com) 进行。如果您想翻译成新的语言,请在 Crowdin 项目中请求管理员添加新语言。
84+
- 官方工具:[go-sdk](https://gitea.com/gitea/go-sdk)、命令行工具[tea](https://gitea.com/gitea/tea)、Gitea Action专用[运行器](https://gitea.com/gitea/act_runner)
85+
- 第三方项目清单:[gitea/awesome-gitea](https://gitea.com/gitea/awesome-gitea),含SDK、插件、主题等资源
7886

79-
您也可以创建一个 issue 来添加语言,或者在 discord 的 #translation 频道上询问。如果您需要上下文或发现一些翻译问题,可以在字符串上留言或在 Discord 上询问。对于一般的翻译问题,文档中有一个部分。目前有点空,但我们希望随着问题的出现而填充它。
8087

81-
更多信息请参阅 [文件](https://docs.gitea.com/contributing/localization)
82-
83-
## 官方和第三方项目
84-
85-
我们提供了一个官方的 [go-sdk](https://gitea.com/gitea/go-sdk),一个名为 [tea](https://gitea.com/gitea/tea) 的 CLI 工具和一个 Gitea Action 的 [action runner](https://gitea.com/gitea/act_runner)
86-
87-
我们在 [gitea/awesome-gitea](https://gitea.com/gitea/awesome-gitea) 维护了一个 Gitea 相关项目的列表,您可以在那里发现更多的第三方项目,包括 SDK、插件、主题等。
88-
89-
## 通讯
88+
## 交流渠道
9089

9190
[![](https://img.shields.io/discord/322538954119184384.svg?logo=discord&logoColor=white&label=Discord&color=5865F2)](https://discord.gg/Gitea "Join the Discord chat at https://discord.gg/Gitea")
9291

93-
如果您有任何文件未涵盖的问题,可以在我们的 [Discord 服务器](https://discord.gg/Gitea) 上与我们联系,或者在 [discourse 论坛](https://forum.gitea.com/) 上创建帖子。
9492

95-
## 作者
93+
若文档未覆盖你的问题,可通过[Discord服务器](https://discord.gg/Gitea)联系我们,或在[论坛](https://forum.gitea.com/)发布帖子。
94+
9695

96+
## 项目成员
9797
- [维护者](https://github.com/orgs/go-gitea/people)
9898
- [贡献者](https://github.com/go-gitea/gitea/graphs/contributors)
99-
- [翻译者](options/locale/TRANSLATORS)
99+
- [译者](options/locale/TRANSLATORS)
100100

101-
## 支持者
102101

103-
感谢所有支持者! 🙏 [[成为支持者](https://opencollective.com/gitea#backer)]
102+
## 支持者
103+
感谢所有支持者的鼎力相助!🙏 [[成为支持者](https://opencollective.com/gitea#backer)]
104104

105105
<a href="https://opencollective.com/gitea#backers" target="_blank"><img src="https://opencollective.com/gitea/backers.svg?width=890"></a>
106106

107107
## 赞助商
108-
109-
通过成为赞助商来支持这个项目。您的标志将显示在这里,并带有链接到您的网站。 [[成为赞助商](https://opencollective.com/gitea#sponsor)]
108+
成为赞助商支持项目,你的logo将在此展示并链接至官网。[[成为赞助商](https://opencollective.com/gitea#sponsor)]
110109

111110
<a href="https://opencollective.com/gitea/sponsor/0/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/0/avatar.svg"></a>
112111
<a href="https://opencollective.com/gitea/sponsor/1/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/1/avatar.svg"></a>
@@ -120,26 +119,21 @@
120119
<a href="https://opencollective.com/gitea/sponsor/9/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/9/avatar.svg"></a>
121120

122121
## 常见问题
122+
### Q:Gitea如何发音?
123+
A:发音为[/ɡɪ’ti:/](https://youtu.be/EM71-2uDAoY),类似“gi-tea”,“g”需发重音。
123124

124-
**Gitea 怎么发音?**
125-
126-
Gitea 的发音是 [/ɡɪ’ti:/](https://youtu.be/EM71-2uDAoY),就像 "gi-tea" 一样,g 是硬音。
125+
### Q:为何项目代码未托管在Gitea自身实例上?
126+
A:我们正推进此事,进展可查看[该issue](https://github.com/go-gitea/gitea/issues/1029)
127127

128-
**为什么这个项目没有托管在 Gitea 实例上?**
128+
### Q:哪里可找到安全补丁?
129+
A:在[发布日志](https://github.com/go-gitea/gitea/releases)[更新日志](https://github.com/go-gitea/gitea/blob/main/CHANGELOG.md)中,搜索关键词`SECURITY`即可找到。
129130

130-
我们正在 [努力](https://github.com/go-gitea/gitea/issues/1029)
131-
132-
**在哪里可以找到安全补丁?**
133-
134-
[发布日志](https://github.com/go-gitea/gitea/releases)[变更日志](https://github.com/go-gitea/gitea/blob/main/CHANGELOG.md) 中,搜索关键词 `SECURITY` 以找到安全补丁。
135131

136132
## 许可证
133+
本项目采用MIT许可证,完整许可文本详见[LICENSE文件](https://github.com/go-gitea/gitea/blob/main/LICENSE)
137134

138-
这个项目是根据 MIT 许可证授权的。
139-
请参阅 [LICENSE](https://github.com/go-gitea/gitea/blob/main/LICENSE) 文件以获取完整的许可证文本。
140-
141-
## 进一步信息
142135

136+
## 更多信息
143137
<details>
144138
<summary>寻找界面概述?查看这里!</summary>
145139

0 commit comments

Comments
 (0)