2016-12-19 21:30:52 +08:00
[简体中文 ](https://github.com/go-gitea/gitea/blob/master/README_ZH.md )
2016-11-03 22:50:44 +08:00
# Gitea - Git with a cup of tea
2017-01-15 21:31:34 +08:00
[](https://drone.gitea.io/go-gitea/gitea)
2017-08-21 23:35:08 +08:00
[](https://discord.gg/NsatcWJ)
2017-01-15 21:31:34 +08:00
[](https://microbadger.com/images/gitea/gitea "Get your own image badge on microbadger.com")
2017-09-13 20:57:55 +08:00
[](https://codecov.io/gh/go-gitea/gitea)
2016-11-25 04:43:05 +08:00
[](https://goreportcard.com/report/code.gitea.io/gitea)
[](https://godoc.org/code.gitea.io/gitea)
2018-05-11 04:38:57 +08:00
[](https://github.com/go-gitea/gitea/releases/latest)
2018-01-09 07:01:08 +08:00
[](https://www.codetriage.com/go-gitea/gitea)
2018-04-17 17:10:34 +08:00
[](https://opencollective.com/gitea)
2014-03-13 14:55:14 +08:00
2017-03-21 09:44:59 +08:00
| | | |
|:---:|:---:|:---:|
2017-11-14 19:23:55 +08:00
||||
||||
||||
||||
2015-08-16 01:41:11 +08:00
2014-02-13 01:49:46 +08:00
## Purpose
2017-08-30 09:27:23 +08:00
The goal of this project is to make the easiest, fastest, and most
painless way of setting up a self-hosted Git service.
Using Go, this can be done with an independent binary distribution across
**all platforms** which Go supports, including Linux, macOS, and Windows
on x86, amd64, ARM and PowerPC architectures.
Want to try it before doing anything else?
Do it [with the online demo ](https://try.gitea.io/ )!
This project has been
[forked ](https://blog.gitea.io/2016/12/welcome-to-gitea/ ) from
2017-11-14 19:23:55 +08:00
[Gogs ](https://gogs.io ) since 2016.11 but changed a lot.
2015-10-29 15:21:59 +08:00
2018-01-01 21:38:49 +08:00
## Building
2015-09-12 21:21:09 +08:00
2018-01-01 21:38:49 +08:00
From the root of the source tree, run:
2014-02-13 01:49:46 +08:00
2018-01-01 21:38:49 +08:00
make generate all
2014-02-13 01:49:46 +08:00
2018-01-01 21:38:49 +08:00
More info: https://docs.gitea.io/en-us/install-from-source/
## Using
./gitea web
NOTE: If you're interested in using our APIs, we have experimental
support with [documentation ](https://godoc.org/code.gitea.io/sdk/gitea ).
2014-02-13 01:49:46 +08:00
2016-11-28 21:34:06 +08:00
## Contributing
2018-01-01 21:38:49 +08:00
Expected workflow is: Fork -> Patch -> Push -> Pull Request
NOTES:
1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.**
2. If you have found a vulnerability in the project, please write privately to **security@gitea.io** . Thanks!
## Further information
For more information and instructions about how to install Gitea, please look
at our [documentation ](https://docs.gitea.io/en-us/ ). 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/NsatcWJ ),
[Matrix room ](https://matrix.to/#/#gitea:matrix.org ),
or [forum ](https://discourse.gitea.io/ )!
2016-11-28 21:34:06 +08:00
## Authors
* [Maintainers ](https://github.com/orgs/go-gitea/people )
* [Contributors ](https://github.com/go-gitea/gitea/graphs/contributors )
2016-12-23 22:05:24 +08:00
* [Translators ](options/locale/TRANSLATORS )
2014-03-28 00:34:12 +08:00
## License
2017-08-30 09:27:23 +08:00
This project is licensed under the MIT License.
See the [LICENSE ](https://github.com/go-gitea/gitea/blob/master/LICENSE ) file
for the full license text.
