You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 6.7KB

10 years ago
10 years ago
8 years ago
8 years ago
10 years ago
10 years ago
10 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. [简体中文](README_ZH.md)
  2. <h1> <img src="https://raw.githubusercontent.com/go-gitea/gitea/master/public/img/gitea-192.png" alt="logo" width="30" height="30"> Gitea - Git with a cup of tea</h1>
  3. [![Build Status](https://drone.gitea.io/api/badges/go-gitea/gitea/status.svg)](https://drone.gitea.io/go-gitea/gitea)
  4. [![Join the Discord chat at https://discord.gg/Gitea](https://img.shields.io/discord/322538954119184384.svg)](https://discord.gg/Gitea)
  5. [![](https://images.microbadger.com/badges/image/gitea/gitea.svg)](https://microbadger.com/images/gitea/gitea "Get your own image badge on microbadger.com")
  6. [![codecov](https://codecov.io/gh/go-gitea/gitea/branch/master/graph/badge.svg)](https://codecov.io/gh/go-gitea/gitea)
  7. [![Go Report Card](https://goreportcard.com/badge/code.gitea.io/gitea)](https://goreportcard.com/report/code.gitea.io/gitea)
  8. [![GoDoc](https://godoc.org/code.gitea.io/gitea?status.svg)](https://godoc.org/code.gitea.io/gitea)
  9. [![GitHub release](https://img.shields.io/github/release/go-gitea/gitea.svg)](https://github.com/go-gitea/gitea/releases/latest)
  10. [![Help Contribute to Open Source](https://www.codetriage.com/go-gitea/gitea/badges/users.svg)](https://www.codetriage.com/go-gitea/gitea)
  11. [![Become a backer/sponsor of gitea](https://opencollective.com/gitea/tiers/backers/badge.svg?label=backers&color=brightgreen)](https://opencollective.com/gitea)
  12. [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
  13. [![Crowdin](https://badges.crowdin.net/gitea/localized.svg)](https://crowdin.com/project/gitea)
  14. ## Purpose
  15. The goal of this project is to make the easiest, fastest, and most
  16. painless way of setting up a self-hosted Git service.
  17. Using Go, this can be done with an independent binary distribution across
  18. **all platforms** which Go supports, including Linux, macOS, and Windows
  19. on x86, amd64, ARM and PowerPC architectures.
  20. Want to try it before doing anything else?
  21. Do it [with the online demo](https://try.gitea.io/)!
  22. This project has been
  23. [forked](https://blog.gitea.io/2016/12/welcome-to-gitea/) from
  24. [Gogs](https://gogs.io) since 2016.11 but changed a lot.
  25. ## Building
  26. From the root of the source tree, run:
  27. TAGS="bindata" make build
  28. or if sqlite support is required:
  29. TAGS="bindata sqlite sqlite_unlock_notify" make build
  30. The `build` target is split into two sub-targets:
  31. - `make backend` which requires [Go 1.12](https://golang.org/dl/) or greater.
  32. - `make frontend` which requires [Node.js 10.13](https://nodejs.org/en/download/) or greater.
  33. If pre-built frontend files are present it is possible to only build the backend:
  34. TAGS="bindata" make backend
  35. More info: https://docs.gitea.io/en-us/install-from-source/
  36. ## Using
  37. ./gitea web
  38. NOTE: If you're interested in using our APIs, we have experimental
  39. support with [documentation](https://try.gitea.io/api/swagger).
  40. ## Contributing
  41. Expected workflow is: Fork -> Patch -> Push -> Pull Request
  42. NOTES:
  43. 1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.**
  44. 2. If you have found a vulnerability in the project, please write privately to **security@gitea.io**. Thanks!
  45. ## Further information
  46. For more information and instructions about how to install Gitea, please look
  47. at our [documentation](https://docs.gitea.io/en-us/). If you have questions
  48. that are not covered by the documentation, you can get in contact with us on
  49. our [Discord server](https://discord.gg/Gitea),
  50. or [forum](https://discourse.gitea.io/)!
  51. ## Authors
  52. * [Maintainers](https://github.com/orgs/go-gitea/people)
  53. * [Contributors](https://github.com/go-gitea/gitea/graphs/contributors)
  54. * [Translators](options/locale/TRANSLATORS)
  55. ## Backers
  56. Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/gitea#backer)]
  57. <a href="https://opencollective.com/gitea#backers" target="_blank"><img src="https://opencollective.com/gitea/backers.svg?width=890"></a>
  58. ## Sponsors
  59. Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/gitea#sponsor)]
  60. <a href="https://opencollective.com/gitea/sponsor/0/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/0/avatar.svg"></a>
  61. <a href="https://opencollective.com/gitea/sponsor/1/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/1/avatar.svg"></a>
  62. <a href="https://opencollective.com/gitea/sponsor/2/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/2/avatar.svg"></a>
  63. <a href="https://opencollective.com/gitea/sponsor/3/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/3/avatar.svg"></a>
  64. <a href="https://opencollective.com/gitea/sponsor/4/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/4/avatar.svg"></a>
  65. <a href="https://opencollective.com/gitea/sponsor/5/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/5/avatar.svg"></a>
  66. <a href="https://opencollective.com/gitea/sponsor/6/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/6/avatar.svg"></a>
  67. <a href="https://opencollective.com/gitea/sponsor/7/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/7/avatar.svg"></a>
  68. <a href="https://opencollective.com/gitea/sponsor/8/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/8/avatar.svg"></a>
  69. <a href="https://opencollective.com/gitea/sponsor/9/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/9/avatar.svg"></a>
  70. ## FAQ
  71. **How do you pronounce Gitea?**
  72. Gitea is pronounced [/ɡɪ’ti:/](https://youtu.be/EM71-2uDAoY) as in "gi-tea" with a hard g.
  73. **Why is this not hosted on a Gitea instance?**
  74. We're [working on it](https://github.com/go-gitea/gitea/issues/1029).
  75. ## License
  76. This project is licensed under the MIT License.
  77. See the [LICENSE](https://github.com/go-gitea/gitea/blob/master/LICENSE) file
  78. for the full license text.
  79. ## Screenshots
  80. Looking for an overview of the interface? Check it out!
  81. |![Dashboard](https://dl.gitea.io/screenshots/home_timeline.png)|![User Profile](https://dl.gitea.io/screenshots/user_profile.png)|![Global Issues](https://dl.gitea.io/screenshots/global_issues.png)|
  82. |:---:|:---:|:---:|
  83. |![Branches](https://dl.gitea.io/screenshots/branches.png)|![Web Editor](https://dl.gitea.io/screenshots/web_editor.png)|![Activity](https://dl.gitea.io/screenshots/activity.png)|
  84. |![New Migration](https://dl.gitea.io/screenshots/migration.png)|![Migrating](https://dl.gitea.io/screenshots/migration.gif)|![Pull Request View](https://image.ibb.co/e02dSb/6.png)
  85. ![Pull Request Dark](https://dl.gitea.io/screenshots/pull_requests_dark.png)|![Diff Review Dark](https://dl.gitea.io/screenshots/review_dark.png)|![Diff Dark](https://dl.gitea.io/screenshots/diff_dark.png)|