mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-11-04 09:44:21 +00:00 
			
		
		
		
	Update README.md (#33149)
~~Waiting for the upload of screenshots~~ I have a good idea about the screenshots. I will do it later. --------- Co-authored-by: Gary Wang <git@blumia.net>
This commit is contained in:
		
							
								
								
									
										2
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							@@ -13,5 +13,5 @@ contact_links:
 | 
				
			|||||||
    url: https://docs.gitea.com/help/faq
 | 
					    url: https://docs.gitea.com/help/faq
 | 
				
			||||||
    about: Please check if your question isn't mentioned here.
 | 
					    about: Please check if your question isn't mentioned here.
 | 
				
			||||||
  - name: Crowdin Translations
 | 
					  - name: Crowdin Translations
 | 
				
			||||||
    url: https://crowdin.com/project/gitea
 | 
					    url: https://translate.gitea.com
 | 
				
			||||||
    about: Translations are managed here.
 | 
					    about: Translations are managed here.
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -182,7 +182,7 @@ Here's how to run the test suite:
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Translation
 | 
					## Translation
 | 
				
			||||||
 | 
					
 | 
				
			||||||
All translation work happens on [Crowdin](https://crowdin.com/project/gitea).
 | 
					All translation work happens on [Crowdin](https://translate.gitea.com).
 | 
				
			||||||
The only translation that is maintained in this repository is [the English translation](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini).
 | 
					The only translation that is maintained in this repository is [the English translation](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini).
 | 
				
			||||||
It is synced regularly with Crowdin. \
 | 
					It is synced regularly with Crowdin. \
 | 
				
			||||||
Other locales on main branch **should not** be updated manually as they will be overwritten with each sync. \
 | 
					Other locales on main branch **should not** be updated manually as they will be overwritten with each sync. \
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										42
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										42
									
								
								README.md
									
									
									
									
									
								
							@@ -9,7 +9,7 @@
 | 
				
			|||||||
[](https://opencollective.com/gitea "Become a backer/sponsor of gitea")
 | 
					[](https://opencollective.com/gitea "Become a backer/sponsor of gitea")
 | 
				
			||||||
[](https://opensource.org/licenses/MIT "License: MIT")
 | 
					[](https://opensource.org/licenses/MIT "License: MIT")
 | 
				
			||||||
[](https://gitpod.io/#https://github.com/go-gitea/gitea)
 | 
					[](https://gitpod.io/#https://github.com/go-gitea/gitea)
 | 
				
			||||||
[](https://crowdin.com/project/gitea "Crowdin")
 | 
					[](https://translate.gitea.com "Crowdin")
 | 
				
			||||||
 | 
					
 | 
				
			||||||
[View this document in Chinese](./README_ZH.md)
 | 
					[View this document in Chinese](./README_ZH.md)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -31,6 +31,14 @@ For accessing free Gitea service (with a limited number of repositories), you ca
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
To quickly deploy your own dedicated Gitea instance on Gitea Cloud, you can start a free trial at [cloud.gitea.com](https://cloud.gitea.com).
 | 
					To quickly deploy your own dedicated Gitea instance on Gitea Cloud, you can start a free trial at [cloud.gitea.com](https://cloud.gitea.com).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Documentation
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					You can find comprehensive documentation on our official [documentation website](https://docs.gitea.com/).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					It includes installation, administration, usage, development, contributing guides, and more to help you get started and explore all features effectively.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					If you have any suggestions or would like to contribute to it, you can visit the [documentation repository](https://gitea.com/gitea/docs)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Building
 | 
					## Building
 | 
				
			||||||
 | 
					
 | 
				
			||||||
From the root of the source tree, run:
 | 
					From the root of the source tree, run:
 | 
				
			||||||
@@ -52,6 +60,8 @@ More info: https://docs.gitea.com/installation/install-from-source
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Using
 | 
					## Using
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					After building, a binary file named `gitea` will be generated in the root of the source tree by default. To run it, use:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    ./gitea web
 | 
					    ./gitea web
 | 
				
			||||||
 | 
					
 | 
				
			||||||
> [!NOTE]
 | 
					> [!NOTE]
 | 
				
			||||||
@@ -68,22 +78,25 @@ Expected workflow is: Fork -> Patch -> Push -> Pull Request
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Translating
 | 
					## Translating
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Translations are done through Crowdin. If you want to translate to a new language ask one of the managers in the Crowdin project to add a new language there.
 | 
					[](https://translate.gitea.com)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Translations are done through [Crowdin](https://translate.gitea.com). If you want to translate to a new language ask one of the managers in the Crowdin project to add a new language there.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
You can also just create an issue for adding a language or ask on discord on the #translation channel. If you need context or find some translation issues, you can leave a comment on the string or ask on Discord. For general translation questions there is a section in the docs. Currently a bit empty but we hope to fill it as questions pop up.
 | 
					You can also just create an issue for adding a language or ask on discord on the #translation channel. If you need context or find some translation issues, you can leave a comment on the string or ask on Discord. For general translation questions there is a section in the docs. Currently a bit empty but we hope to fill it as questions pop up.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
https://docs.gitea.com/contributing/localization
 | 
					Get more information from [documentation](https://docs.gitea.com/contributing/localization).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
[](https://crowdin.com/project/gitea)
 | 
					## Official and Third-Party Projects
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Further information
 | 
					We provide an official [go-sdk](https://gitea.com/gitea/go-sdk), a CLI tool called [tea](https://gitea.com/gitea/tea) and an [action runner](https://gitea.com/gitea/act_runner) for Gitea Action.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
For more information and instructions about how to install Gitea, please look at our [documentation](https://docs.gitea.com/).
 | 
					We maintain a list of Gitea-related projects at [gitea/awesome-gitea](https://gitea.com/gitea/awesome-gitea), where you can discover more third-party projects, including SDKs, plugins, themes, and more.
 | 
				
			||||||
If you have questions that are not covered by the documentation, you can get in contact with us on our [Discord server](https://discord.gg/Gitea) or create  a post in the [discourse forum](https://forum.gitea.com/).
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
We maintain a list of Gitea-related projects at [gitea/awesome-gitea](https://gitea.com/gitea/awesome-gitea).
 | 
					## Communication
 | 
				
			||||||
 | 
					
 | 
				
			||||||
The official Gitea CLI is developed at [gitea/tea](https://gitea.com/gitea/tea).
 | 
					[](https://discord.gg/Gitea "Join the Discord chat at https://discord.gg/Gitea")
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					If you have questions that are not covered by the [documentation](https://docs.gitea.com/), you can get in contact with us on our [Discord server](https://discord.gg/Gitea) or create a post in the [discourse forum](https://forum.gitea.com/).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Authors
 | 
					## Authors
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -122,18 +135,25 @@ Gitea is pronounced [/ɡɪ’ti:/](https://youtu.be/EM71-2uDAoY) as in "gi-tea"
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
We're [working on it](https://github.com/go-gitea/gitea/issues/1029).
 | 
					We're [working on it](https://github.com/go-gitea/gitea/issues/1029).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Where can I find the security patches?**
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					In the [release log](https://github.com/go-gitea/gitea/releases) or the [change log](https://github.com/go-gitea/gitea/blob/main/CHANGELOG.md), search for the keyword `SECURITY` to find the security patches.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## License
 | 
					## License
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This project is licensed under the MIT License.
 | 
					This project is licensed under the MIT License.
 | 
				
			||||||
See the [LICENSE](https://github.com/go-gitea/gitea/blob/main/LICENSE) file
 | 
					See the [LICENSE](https://github.com/go-gitea/gitea/blob/main/LICENSE) file
 | 
				
			||||||
for the full license text.
 | 
					for the full license text.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Screenshots
 | 
					## Further information
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Looking for an overview of the interface? Check it out!
 | 
					<details>
 | 
				
			||||||
 | 
					<summary>Looking for an overview of the interface? Check it out!</summary>
 | 
				
			||||||
 | 
					
 | 
				
			||||||
||||
 | 
					||||
 | 
				
			||||||
|:---:|:---:|:---:|
 | 
					|:---:|:---:|:---:|
 | 
				
			||||||
||||
 | 
					||||
 | 
				
			||||||
||||
 | 
					||||
 | 
				
			||||||
||||
 | 
					||||
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					</details>
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										73
									
								
								README_ZH.md
									
									
									
									
									
								
							
							
						
						
									
										73
									
								
								README_ZH.md
									
									
									
									
									
								
							@@ -9,13 +9,13 @@
 | 
				
			|||||||
[](https://opencollective.com/gitea "Become a backer/sponsor of gitea")
 | 
					[](https://opencollective.com/gitea "Become a backer/sponsor of gitea")
 | 
				
			||||||
[](https://opensource.org/licenses/MIT "License: MIT")
 | 
					[](https://opensource.org/licenses/MIT "License: MIT")
 | 
				
			||||||
[](https://gitpod.io/#https://github.com/go-gitea/gitea)
 | 
					[](https://gitpod.io/#https://github.com/go-gitea/gitea)
 | 
				
			||||||
[](https://crowdin.com/project/gitea "Crowdin")
 | 
					[](https://translate.gitea.com "Crowdin")
 | 
				
			||||||
 | 
					
 | 
				
			||||||
[View this document in English](./README.md)
 | 
					[View this document in English](./README.md)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## 目标
 | 
					## 目标
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Gitea 的首要目标是创建一个极易安装,运行非常快速,安装和使用体验良好的自建 Git 服务。我们采用 Go 作为后端语言,这使我们只要生成一个可执行程序即可。并且他还支持跨平台,支持 Linux, macOS 和 Windows 以及各种架构,除了 x86,amd64,还包括 ARM 和 PowerPC。
 | 
					Gitea 的首要目标是创建一个极易安装,运行非常快速,安装和使用体验良好的自建 Git 服务。我们采用 Go 作为后端语言,这使我们只要生成一个可执行程序即可。并且他还支持跨平台,支持 Linux、macOS 和 Windows 以及各种架构,除了 x86 和 amd64,还包括 ARM 和 PowerPC。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
如果你想试用在线演示和报告问题,请访问 [demo.gitea.com](https://demo.gitea.com/)。
 | 
					如果你想试用在线演示和报告问题,请访问 [demo.gitea.com](https://demo.gitea.com/)。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -23,39 +23,80 @@ Gitea 的首要目标是创建一个极易安装,运行非常快速,安装
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
如果你想在 Gitea Cloud 上快速部署你自己独享的 Gitea 实例,请访问 [cloud.gitea.com](https://cloud.gitea.com) 开始免费试用。
 | 
					如果你想在 Gitea Cloud 上快速部署你自己独享的 Gitea 实例,请访问 [cloud.gitea.com](https://cloud.gitea.com) 开始免费试用。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## 提示
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
1. **开始贡献代码之前请确保你已经看过了 [贡献者向导(英文)](CONTRIBUTING.md)**.
 | 
					 | 
				
			||||||
2. 所有的安全问题,请私下发送邮件给 **security@gitea.io**。谢谢!
 | 
					 | 
				
			||||||
3. 如果你要使用API,请参见 [API 文档](https://godoc.org/code.gitea.io/sdk/gitea).
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## 文档
 | 
					## 文档
 | 
				
			||||||
 | 
					
 | 
				
			||||||
关于如何安装请访问我们的 [文档站](https://docs.gitea.com/zh-cn/category/installation),如果没有找到对应的文档,你也可以通过 [Discord - 英文](https://discord.gg/gitea) 和 QQ群 328432459 来和我们交流。
 | 
					关于如何安装请访问我们的 [文档站](https://docs.gitea.com/zh-cn/category/installation),如果没有找到对应的文档,你也可以通过 [Discord - 英文](https://discord.gg/gitea) 和 QQ群 328432459 来和我们交流。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## 贡献流程
 | 
					## 编译
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Fork -> Patch -> Push -> Pull Request
 | 
					在源代码的根目录下执行:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    TAGS="bindata" make build
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					或者如果需要SQLite支持:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    TAGS="bindata sqlite sqlite_unlock_notify" make build
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					编译过程会分成2个子任务:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- `make backend`,需要 [Go Stable](https://go.dev/dl/),最低版本需求可查看 [go.mod](/go.mod)。
 | 
				
			||||||
 | 
					- `make frontend`,需要 [Node.js LTS](https://nodejs.org/en/download/) 或更高版本。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					你需要连接网络来下载 go 和 npm modules。当从 tar 格式的源文件编译时,其中包含了预编译的前端文件,因此 `make frontend` 将不会被执行。这允许编译时不需要 Node.js。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					更多信息: https://docs.gitea.com/installation/install-from-source
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 使用
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					编译之后,默认会在根目录下生成一个名为 `gitea` 的文件。你可以这样执行它:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    ./gitea web
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					> [!注意]
 | 
				
			||||||
 | 
					> 如果你要使用API,请参见 [API 文档](https://godoc.org/code.gitea.io/sdk/gitea)。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 贡献
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					贡献流程:Fork -> Patch -> Push -> Pull Request
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					> [!注意]
 | 
				
			||||||
 | 
					>
 | 
				
			||||||
 | 
					> 1. **开始贡献代码之前请确保你已经看过了 [贡献者向导(英文)](CONTRIBUTING.md)**。
 | 
				
			||||||
 | 
					> 2. 所有的安全问题,请私下发送邮件给 **security@gitea.io**。 谢谢!
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## 翻译
 | 
					## 翻译
 | 
				
			||||||
 | 
					
 | 
				
			||||||
多语言翻译是基于Crowdin进行的.
 | 
					[](https://translate.gitea.com)
 | 
				
			||||||
[](https://crowdin.com/project/gitea)
 | 
					
 | 
				
			||||||
 | 
					多语言翻译是基于Crowdin进行的。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					从 [文档](https://docs.gitea.com/contributing/localization) 中获取更多信息。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 官方和第三方项目
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Gitea 提供官方的 [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)。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					[gitea/awesome-gitea](https://gitea.com/gitea/awesome-gitea) 是一个 Gitea 相关项目的列表,你可以在这里找到更多的第三方项目,包括 SDK、插件、主题等等。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## 作者
 | 
					## 作者
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* [Maintainers](https://github.com/orgs/go-gitea/people)
 | 
					- [Maintainers](https://github.com/orgs/go-gitea/people)
 | 
				
			||||||
* [Contributors](https://github.com/go-gitea/gitea/graphs/contributors)
 | 
					- [Contributors](https://github.com/go-gitea/gitea/graphs/contributors)
 | 
				
			||||||
* [Translators](options/locale/TRANSLATORS)
 | 
					- [Translators](options/locale/TRANSLATORS)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## 授权许可
 | 
					## 授权许可
 | 
				
			||||||
 | 
					
 | 
				
			||||||
本项目采用 MIT 开源授权许可证,完整的授权说明已放置在 [LICENSE](https://github.com/go-gitea/gitea/blob/main/LICENSE) 文件中。
 | 
					本项目采用 MIT 开源授权许可证,完整的授权说明已放置在 [LICENSE](https://github.com/go-gitea/gitea/blob/main/LICENSE) 文件中。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## 截图
 | 
					## 更多信息
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					<details>
 | 
				
			||||||
 | 
					<summary>截图</summary>
 | 
				
			||||||
 | 
					
 | 
				
			||||||
||||
 | 
					||||
 | 
				
			||||||
|:---:|:---:|:---:|
 | 
					|:---:|:---:|:---:|
 | 
				
			||||||
||||
 | 
					||||
 | 
				
			||||||
||||
 | 
					||||
 | 
				
			||||||
||||
 | 
					||||
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					</details>
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user