github-mirror/gitea
2
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2024-11-22 12:25:57 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
920c0bde2d
gitea/README.md

166 lines
8.0 KiB
Markdown
Raw Normal View History

Consolidate Logos and update README header (#14136) * Consolidate Logos and update README header - Remove unused `logo-lg.png`, `logo-sm.png` and `logo-192.png`. - Consolidate `favicon.svg` and `logo.svg` to just `logo.svg`. - Remove Safari Mask icon, it seems to work fine with just `favicon.png` (no SVG support). - Remove Fluid Icon. It only served Firefox and SVG works just fine there. - Update customization instructions. - Update README.md to use SVG icon, increase logo size and center it and badges. * Update README_ZH.md Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> * Update README_ZH.md Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2021-01-02 03:04:35 +08:00
<p align="center">
<a href="https://gitea.io/">
<img alt="Gitea" src="https://raw.githubusercontent.com/go-gitea/gitea/master/public/img/gitea.svg" width="220"/>
</a>
</p>
<h1 align="center">Gitea - Git with a cup of tea</h1>
add ZH readme (#405)
2016-12-19 21:30:52 +08:00
Consolidate Logos and update README header (#14136) * Consolidate Logos and update README header - Remove unused `logo-lg.png`, `logo-sm.png` and `logo-192.png`. - Consolidate `favicon.svg` and `logo.svg` to just `logo.svg`. - Remove Safari Mask icon, it seems to work fine with just `favicon.png` (no SVG support). - Remove Fluid Icon. It only served Firefox and SVG works just fine there. - Update customization instructions. - Update README.md to use SVG icon, increase logo size and center it and badges. * Update README_ZH.md Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> * Update README_ZH.md Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2021-01-02 03:04:35 +08:00
<p align="center">
<a href="https://drone.gitea.io/go-gitea/gitea" title="Build Status">
<img src="https://drone.gitea.io/api/badges/go-gitea/gitea/status.svg?ref=refs/heads/master">
</a>
<a href="https://discord.gg/Gitea" title="Join the Discord chat at https://discord.gg/Gitea">
<img src="https://img.shields.io/discord/322538954119184384.svg">
</a>
<a href="https://microbadger.com/images/gitea/gitea" title="Get your own image badge on microbadger.com">
<img src="https://images.microbadger.com/badges/image/gitea/gitea.svg">
</a>
<a href="https://codecov.io/gh/go-gitea/gitea" title="Codecov">
<img src="https://codecov.io/gh/go-gitea/gitea/branch/master/graph/badge.svg">
</a>
<a href="https://godoc.org/code.gitea.io/gitea" title="Go Report Card">
<img src="https://goreportcard.com/badge/code.gitea.io/gitea">
</a>
<a href="https://godoc.org/code.gitea.io/gitea" title="GoDoc">
<img src="https://godoc.org/code.gitea.io/gitea?status.svg">
</a>
<a href="https://github.com/go-gitea/gitea/releases/latest" title="GitHub release">
<img src="https://img.shields.io/github/release/go-gitea/gitea.svg">
</a>
<a href="https://www.codetriage.com/go-gitea/gitea" title="Help Contribute to Open Source">
<img src="https://www.codetriage.com/go-gitea/gitea/badges/users.svg">
</a>
<a href="https://opencollective.com/gitea" title="Become a backer/sponsor of gitea">
<img src="https://opencollective.com/gitea/tiers/backers/badge.svg?label=backers&color=brightgreen">
</a>
<a href="https://opensource.org/licenses/MIT" title="License: MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg">
</a>
<a href="https://crowdin.com/project/gitea" title="Crowdin">
<img src="https://badges.crowdin.net/gitea/localized.svg">
</a>
<a href="https://www.tickgit.com/browse?repo=github.com/go-gitea/gitea" title="TODOs">
<img src="https://badgen.net/https/api.tickgit.com/badgen/github.com/go-gitea/gitea">
</a>
Kd/add bountysource (#14323) * Add bountysource to Sponsors link * Add badge to readme
2021-01-13 23:53:17 +08:00
<a href="https://img.shields.io/bountysource/team/gitea" title="Bountysource">
<img src="https://img.shields.io/bountysource/team/gitea/activity">
</a>
Consolidate Logos and update README header (#14136) * Consolidate Logos and update README header - Remove unused `logo-lg.png`, `logo-sm.png` and `logo-192.png`. - Consolidate `favicon.svg` and `logo.svg` to just `logo.svg`. - Remove Safari Mask icon, it seems to work fine with just `favicon.png` (no SVG support). - Remove Fluid Icon. It only served Firefox and SVG works just fine there. - Update customization instructions. - Update README.md to use SVG icon, increase logo size and center it and badges. * Update README_ZH.md Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> * Update README_ZH.md Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2021-01-02 03:04:35 +08:00
</p>
Badges and travis testing (#40) * Added badges to the README * Restructured the travis config
2016-11-03 22:50:44 +08:00
Consolidate Logos and update README header (#14136) * Consolidate Logos and update README header - Remove unused `logo-lg.png`, `logo-sm.png` and `logo-192.png`. - Consolidate `favicon.svg` and `logo.svg` to just `logo.svg`. - Remove Safari Mask icon, it seems to work fine with just `favicon.png` (no SVG support). - Remove Fluid Icon. It only served Firefox and SVG works just fine there. - Update customization instructions. - Update README.md to use SVG icon, increase logo size and center it and badges. * Update README_ZH.md Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> * Update README_ZH.md Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2021-01-02 03:04:35 +08:00
<p align="center">
<a href="README_ZH.md">View the chinese version of this document</a>
</p>
Update README
2014-03-13 14:55:14 +08:00
Init commit
2014-02-13 01:49:46 +08:00
## Purpose
Wrap most paragraphs to 80 columns (#2396) Reduces patches size and makes them more readable
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
update screenshots on README (#2910)
2017-11-14 19:23:55 +08:00
[Gogs](https://gogs.io) since 2016.11 but changed a lot.
update README
2015-10-29 15:21:59 +08:00
Add build instruction in README, reorganize some sections (#3257) * Add build instruction in README, reorganize some sections * Add link to https://docs.gitea.io/en-us/install-from-source/
2018-01-01 21:38:49 +08:00
## Building
typo and README
2015-09-12 21:21:09 +08:00
Add build instruction in README, reorganize some sections (#3257) * Add build instruction in README, reorganize some sections * Add link to https://docs.gitea.io/en-us/install-from-source/
2018-01-01 21:38:49 +08:00
From the root of the source tree, run:
Init commit
2014-02-13 01:49:46 +08:00
Remove explicit 'generate' calls, fix release task (#9288) * Remove more explicit 'generate' calls `generate` is now implicit during `build` since #9114, it is no longer necessary or desired to specify it explicitely. * add js,css,generate dependencies to release task * remove generate warning as per @lunny
2019-12-09 00:56:59 +08:00
TAGS="bindata" make build
Init commit
2014-02-13 01:49:46 +08:00
Update documentation for the go module era (#9751) * Update documentation for the go module era use go env instead of $GOPATH Update instructions to just use git clone Slight update to readme Signed-off-by: Andrew Thornton <art27@cantab.net> * fixup * Apply suggestions from code review Co-Authored-By: Antoine GIRARD <sapk@users.noreply.github.com> Co-Authored-By: Bagas Sanjaya <bagasdotme@gmail.com> * Apply suggestions from code review * Fix GOPATH settings Co-authored-by: Antoine GIRARD <sapk@users.noreply.github.com> Co-authored-by: Bagas Sanjaya <bagasdotme@gmail.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2020-01-29 10:30:02 +08:00
or if sqlite support is required:
TAGS="bindata sqlite sqlite_unlock_notify" make build
Add frontend/backend make targets, fix source release (#10325) * Add frontend/backend make targets, fix source release - Add 'make backend' and 'make frontend' make targets which are used to build go and js/css/svg files respectively. - The 'backend' target can be invoked without requiring Node.js to be present on the system if pre-built frontend assets are present like in the release source tarballs. - Fix source releases missing 'dist' folders inside 'node_modules' which were erronously excluded from tar. - Store VERSION in file VERSION for the release tarballs and prefer that file over git-derived version. * fix release task * fix typo * fix another typo
2020-02-22 17:15:11 +08:00
The `build` target is split into two sub-targets:
Bump min required golang to 1.13 (#12717) * Bump min required golang to 1.13 * Update config.yaml * Update Makefile * per silverwind feedback * per silverwind Co-authored-by: zeripath <art27@cantab.net>
2020-09-05 02:12:01 +08:00
- `make backend` which requires [Go 1.13](https://golang.org/dl/) or greater.
Update JS dependencies, min Node.js version 10.13 (#11246) `less-loader` now dictates a minimum Node.js version of 10.13.0, released 2018-10-30 so I've updated this requirement to match. https://github.com/webpack-contrib/less-loader/releases/tag/v6.0.0
2020-04-30 18:37:01 +08:00
- `make frontend` which requires [Node.js 10.13](https://nodejs.org/en/download/) or greater.
Add frontend/backend make targets, fix source release (#10325) * Add frontend/backend make targets, fix source release - Add 'make backend' and 'make frontend' make targets which are used to build go and js/css/svg files respectively. - The 'backend' target can be invoked without requiring Node.js to be present on the system if pre-built frontend assets are present like in the release source tarballs. - Fix source releases missing 'dist' folders inside 'node_modules' which were erronously excluded from tar. - Store VERSION in file VERSION for the release tarballs and prefer that file over git-derived version. * fix release task * fix typo * fix another typo
2020-02-22 17:15:11 +08:00
If pre-built frontend files are present it is possible to only build the backend:
fix readme format (#12797) Originally, the tabbed content under 'If pre-built frontend files are present it is possible to only build the backend:‘ has tab within the tabbed content. This commit fixed it. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2020-09-11 01:05:15 +08:00
TAGS="bindata" make backend
Add frontend/backend make targets, fix source release (#10325) * Add frontend/backend make targets, fix source release - Add 'make backend' and 'make frontend' make targets which are used to build go and js/css/svg files respectively. - The 'backend' target can be invoked without requiring Node.js to be present on the system if pre-built frontend assets are present like in the release source tarballs. - Fix source releases missing 'dist' folders inside 'node_modules' which were erronously excluded from tar. - Store VERSION in file VERSION for the release tarballs and prefer that file over git-derived version. * fix release task * fix typo * fix another typo
2020-02-22 17:15:11 +08:00
Add note to README about make parallelism (#12378) Alternative to https://github.com/go-gitea/gitea/pull/12367
2020-07-31 05:21:59 +08:00
Parallelism is not supported for these targets, so please don't include `-j <num>`.
Add build instruction in README, reorganize some sections (#3257) * Add build instruction in README, reorganize some sections * Add link to https://docs.gitea.io/en-us/install-from-source/
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
Update API link in README (#5241)
2018-11-01 08:18:28 +08:00
support with [documentation](https://try.gitea.io/api/swagger).
Init commit
2014-02-13 01:49:46 +08:00
Dropped always outdated contributors file, link to it the graph on readme
2016-11-28 21:34:06 +08:00
## Contributing
Add build instruction in README, reorganize some sections (#3257) * Add build instruction in README, reorganize some sections * Add link to https://docs.gitea.io/en-us/install-from-source/
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
README: Add more contents to the "further information" section. (#13871)
2020-12-06 21:56:46 +08:00
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/Gitea) or create a post in the [discourse forum](https://discourse.gitea.io/).
We maintain a list of Gitea-related projects at [gitea/awesome-gitea](https://gitea.com/gitea/awesome-gitea).
fix: small typo error (#14170) Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2020-12-29 01:08:01 +08:00
The hugo-based documentation theme is hosted at [gitea/theme](https://gitea.com/gitea/theme).
README: Add more contents to the "further information" section. (#13871)
2020-12-06 21:56:46 +08:00
The official Gitea CLI is developed at [gitea/tea](https://gitea.com/gitea/tea).
Dropped always outdated contributors file, link to it the graph on readme
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)
Simplified README and added a release badge (#460) * Dropped the status from readme, it's anway always outdated * Added version badge * Cleaned the install instructions * Dropped paragraphs that should be documented on the docs * Simplified the content, refer to the website * Dropped the logo, lets show screenshots * Fixed TRANSLATORS link
2016-12-23 22:05:24 +08:00
* [Translators](options/locale/TRANSLATORS)
add the license section under the README.md file It's very clear if we add the license type in the README.md
2014-03-28 00:34:12 +08:00
Activating Open Collective (#3821) * Added backers and sponsors on the README * Added call to donate after npm install (optional) * Remove npm changes * Update readme to leave only needed sections
2018-05-11 13:53:23 +08:00
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/gitea#backer)]
<a href="https://opencollective.com/gitea#backers" target="_blank"><img src="https://opencollective.com/gitea/backers.svg?width=890"></a>
## Sponsors
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)]
<a href="https://opencollective.com/gitea/sponsor/0/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/gitea/sponsor/1/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/gitea/sponsor/2/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/gitea/sponsor/3/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/gitea/sponsor/4/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/gitea/sponsor/5/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/gitea/sponsor/6/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/gitea/sponsor/7/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/gitea/sponsor/8/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/gitea/sponsor/9/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/9/avatar.svg"></a>
Add pronunciation to README.md (#4123)
2018-06-05 08:15:32 +08:00
## FAQ
**How do you pronounce Gitea?**
Gitea is pronounced [/ɡɪ’ti:/](https://youtu.be/EM71-2uDAoY) as in "gi-tea" with a hard g.
Added question for Gitea hosted Gitea (#4397) Currently some issues need to be resolved and features need to be implemented before we can move the Gitea development workflow to a Gitea instance. Many ask why Gitea isn't hosted on Gitea, now that's in the FAQ.
2018-07-09 04:41:31 +08:00
**Why is this not hosted on a Gitea instance?**
We're [working on it](https://github.com/go-gitea/gitea/issues/1029).
add the license section under the README.md file It's very clear if we add the license type in the README.md
2014-03-28 00:34:12 +08:00
## License
Wrap most paragraphs to 80 columns (#2396) Reduces patches size and makes them more readable
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.
Move Screenshots to Bottom (#4128) The 'above the fold' space is very important, it seems possibly wasted with screenshots which aren't legible without enlarging. This is a proposal to move them down.
2018-06-09 08:13:41 +08:00
## Screenshots
Looking for an overview of the interface? Check it out!
README: Update Screenshots and Badges in ZH (#8813) * use relative instead of absolute paths * update badges of ZH readme * update screenshots * use <style> for table * remove useles stype * absolute paths for images
2019-11-05 08:12:58 +08:00
|![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)|
Move Screenshots to Bottom (#4128) The 'above the fold' space is very important, it seems possibly wasted with screenshots which aren't legible without enlarging. This is a proposal to move them down.
2018-06-09 08:13:41 +08:00
|:---:|:---:|:---:|
README: Update Screenshots and Badges in ZH (#8813) * use relative instead of absolute paths * update badges of ZH readme * update screenshots * use <style> for table * remove useles stype * absolute paths for images
2019-11-05 08:12:58 +08:00
|![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)|
|![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)
![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)|
Reference in New Issue Copy Permalink