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.

112 lines
6.0 KiB

10 years ago
10 years ago
9 years ago
9 years ago
10 years ago
10 years ago
10 years ago
  1. [简体中文](https://github.com/go-gitea/gitea/blob/master/README_ZH.md)
  2. # Gitea - Git with a cup of tea
  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/NsatcWJ](https://img.shields.io/discord/322538954119184384.svg)](https://discord.gg/NsatcWJ)
  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=backer&color=brightgreen)](https://opencollective.com/gitea)
  12. [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
  13. ## Purpose
  14. The goal of this project is to make the easiest, fastest, and most
  15. painless way of setting up a self-hosted Git service.
  16. Using Go, this can be done with an independent binary distribution across
  17. **all platforms** which Go supports, including Linux, macOS, and Windows
  18. on x86, amd64, ARM and PowerPC architectures.
  19. Want to try it before doing anything else?
  20. Do it [with the online demo](https://try.gitea.io/)!
  21. This project has been
  22. [forked](https://blog.gitea.io/2016/12/welcome-to-gitea/) from
  23. [Gogs](https://gogs.io) since 2016.11 but changed a lot.
  24. ## Building
  25. From the root of the source tree, run:
  26. TAGS="bindata" make generate all
  27. More info: https://docs.gitea.io/en-us/install-from-source/
  28. ## Using
  29. ./gitea web
  30. NOTE: If you're interested in using our APIs, we have experimental
  31. support with [documentation](https://try.gitea.io/api/swagger).
  32. ## Contributing
  33. Expected workflow is: Fork -> Patch -> Push -> Pull Request
  34. NOTES:
  35. 1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.**
  36. 2. If you have found a vulnerability in the project, please write privately to **security@gitea.io**. Thanks!
  37. ## Further information
  38. For more information and instructions about how to install Gitea, please look
  39. at our [documentation](https://docs.gitea.io/en-us/). If you have questions
  40. that are not covered by the documentation, you can get in contact with us on
  41. our [Discord server](https://discord.gg/NsatcWJ),
  42. or [forum](https://discourse.gitea.io/)!
  43. ## Authors
  44. * [Maintainers](https://github.com/orgs/go-gitea/people)
  45. * [Contributors](https://github.com/go-gitea/gitea/graphs/contributors)
  46. * [Translators](options/locale/TRANSLATORS)
  47. ## Backers
  48. Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/gitea#backer)]
  49. <a href="https://opencollective.com/gitea#backers" target="_blank"><img src="https://opencollective.com/gitea/backers.svg?width=890"></a>
  50. ## Sponsors
  51. 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)]
  52. <a href="https://opencollective.com/gitea/sponsor/0/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/0/avatar.svg"></a>
  53. <a href="https://opencollective.com/gitea/sponsor/1/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/1/avatar.svg"></a>
  54. <a href="https://opencollective.com/gitea/sponsor/2/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/2/avatar.svg"></a>
  55. <a href="https://opencollective.com/gitea/sponsor/3/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/3/avatar.svg"></a>
  56. <a href="https://opencollective.com/gitea/sponsor/4/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/4/avatar.svg"></a>
  57. <a href="https://opencollective.com/gitea/sponsor/5/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/5/avatar.svg"></a>
  58. <a href="https://opencollective.com/gitea/sponsor/6/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/6/avatar.svg"></a>
  59. <a href="https://opencollective.com/gitea/sponsor/7/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/7/avatar.svg"></a>
  60. <a href="https://opencollective.com/gitea/sponsor/8/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/8/avatar.svg"></a>
  61. <a href="https://opencollective.com/gitea/sponsor/9/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/9/avatar.svg"></a>
  62. ## FAQ
  63. **How do you pronounce Gitea?**
  64. Gitea is pronounced [/ɡɪ’ti:/](https://youtu.be/EM71-2uDAoY) as in "gi-tea" with a hard g.
  65. **Why is this not hosted on a Gitea instance?**
  66. We're [working on it](https://github.com/go-gitea/gitea/issues/1029).
  67. ## License
  68. This project is licensed under the MIT License.
  69. See the [LICENSE](https://github.com/go-gitea/gitea/blob/master/LICENSE) file
  70. for the full license text.
  71. ## Screenshots
  72. Looking for an overview of the interface? Check it out!
  73. | | | |
  74. |:---:|:---:|:---:|
  75. |![Dashboard](https://image.ibb.co/dms6DG/1.png)|![Repository](https://image.ibb.co/m6MSLw/2.png)|![Commits History](https://image.ibb.co/cjrSLw/3.png)|
  76. |![Branches](https://image.ibb.co/e6vbDG/4.png)|![Issues](https://image.ibb.co/bJTJSb/5.png)|![Pull Request View](https://image.ibb.co/e02dSb/6.png)|
  77. |![Releases](https://image.ibb.co/cUzgfw/7.png)|![Activity](https://image.ibb.co/eZgGDG/8.png)|![Wiki](https://image.ibb.co/dYV9YG/9.png)|
  78. |![Diff](https://image.ibb.co/ewA9YG/10.png)|![Organization](https://image.ibb.co/ceOwDG/11.png)|![Profile](https://image.ibb.co/c44Q7b/12.png)|