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

README.md 7.2 kB

11 years ago
11 years ago
10 years ago
10 years ago
11 years ago
11 years ago
11 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  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?ref=refs/heads/master)](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. [![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/go-gitea/gitea)](https://www.tickgit.com/browse?repo=github.com/go-gitea/gitea)
  15. ## Purpose
  16. The goal of this project is to make the easiest, fastest, and most
  17. painless way of setting up a self-hosted Git service.
  18. Using Go, this can be done with an independent binary distribution across
  19. **all platforms** which Go supports, including Linux, macOS, and Windows
  20. on x86, amd64, ARM and PowerPC architectures.
  21. Want to try it before doing anything else?
  22. Do it [with the online demo](https://try.gitea.io/)!
  23. This project has been
  24. [forked](https://blog.gitea.io/2016/12/welcome-to-gitea/) from
  25. [Gogs](https://gogs.io) since 2016.11 but changed a lot.
  26. ## Building
  27. From the root of the source tree, run:
  28. TAGS="bindata" make build
  29. or if sqlite support is required:
  30. TAGS="bindata sqlite sqlite_unlock_notify" make build
  31. The `build` target is split into two sub-targets:
  32. - `make backend` which requires [Go 1.13](https://golang.org/dl/) or greater.
  33. - `make frontend` which requires [Node.js 10.13](https://nodejs.org/en/download/) or greater.
  34. If pre-built frontend files are present it is possible to only build the backend:
  35. TAGS="bindata" make backend
  36. Parallelism is not supported for these targets, so please don't include `-j <num>`.
  37. More info: https://docs.gitea.io/en-us/install-from-source/
  38. ## Using
  39. ./gitea web
  40. NOTE: If you're interested in using our APIs, we have experimental
  41. support with [documentation](https://try.gitea.io/api/swagger).
  42. ## Contributing
  43. Expected workflow is: Fork -> Patch -> Push -> Pull Request
  44. NOTES:
  45. 1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.**
  46. 2. If you have found a vulnerability in the project, please write privately to **security@gitea.io**. Thanks!
  47. ## Further information
  48. For more information and instructions about how to install Gitea, please look
  49. at our [documentation](https://docs.gitea.io/en-us/). If you have questions
  50. that are not covered by the documentation, you can get in contact with us on
  51. our [Discord server](https://discord.gg/Gitea),
  52. or [forum](https://discourse.gitea.io/)!
  53. ## Authors
  54. * [Maintainers](https://github.com/orgs/go-gitea/people)
  55. * [Contributors](https://github.com/go-gitea/gitea/graphs/contributors)
  56. * [Translators](options/locale/TRANSLATORS)
  57. ## Backers
  58. Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/gitea#backer)]
  59. <a href="https://opencollective.com/gitea#backers" target="_blank"><img src="https://opencollective.com/gitea/backers.svg?width=890"></a>
  60. ## Sponsors
  61. 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)]
  62. <a href="https://opencollective.com/gitea/sponsor/0/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/0/avatar.svg"></a>
  63. <a href="https://opencollective.com/gitea/sponsor/1/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/1/avatar.svg"></a>
  64. <a href="https://opencollective.com/gitea/sponsor/2/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/2/avatar.svg"></a>
  65. <a href="https://opencollective.com/gitea/sponsor/3/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/3/avatar.svg"></a>
  66. <a href="https://opencollective.com/gitea/sponsor/4/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/4/avatar.svg"></a>
  67. <a href="https://opencollective.com/gitea/sponsor/5/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/5/avatar.svg"></a>
  68. <a href="https://opencollective.com/gitea/sponsor/6/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/6/avatar.svg"></a>
  69. <a href="https://opencollective.com/gitea/sponsor/7/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/7/avatar.svg"></a>
  70. <a href="https://opencollective.com/gitea/sponsor/8/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/8/avatar.svg"></a>
  71. <a href="https://opencollective.com/gitea/sponsor/9/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/9/avatar.svg"></a>
  72. ## FAQ
  73. **How do you pronounce Gitea?**
  74. Gitea is pronounced [/ɡɪ’ti:/](https://youtu.be/EM71-2uDAoY) as in "gi-tea" with a hard g.
  75. **Why is this not hosted on a Gitea instance?**
  76. We're [working on it](https://github.com/go-gitea/gitea/issues/1029).
  77. ## License
  78. This project is licensed under the MIT License.
  79. See the [LICENSE](https://github.com/go-gitea/gitea/blob/master/LICENSE) file
  80. for the full license text.
  81. ## Screenshots
  82. Looking for an overview of the interface? Check it out!
  83. |![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)|
  84. |:---:|:---:|:---:|
  85. |![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)|
  86. |![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)
  87. ![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)|