magic_rb/forgejo
Template
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo synced 2024-11-24 18:56:11 +01:00
Code Issues Packages Projects Releases Wiki Activity
forgejo/README.md

130 lines
7.3 KiB
Markdown
Raw Normal View History

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 01:12:58 +01:00
[简体中文](README_ZH.md)
add ZH readme (#405)
2016-12-19 14:30:52 +01:00
Display Gitea logo in Readme (#8592) * readme: add gitea logo * Update README.md * Update README.md * Update README.md
2019-10-19 23:14:38 +02:00
<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>
Badges and travis testing (#40) * Added badges to the README * Restructured the travis config
2016-11-03 15:50:44 +01:00
Show drone status for master branch in README (#12248)
2020-07-15 06:37:38 +02:00
[![Build Status](https://drone.gitea.io/api/badges/go-gitea/gitea/status.svg?ref=refs/heads/master)](https://drone.gitea.io/go-gitea/gitea)
update discord link (#10455)
2020-02-25 18:36:45 +01:00
[![Join the Discord chat at https://discord.gg/Gitea](https://img.shields.io/discord/322538954119184384.svg)](https://discord.gg/Gitea)
Changed README to refer to https images only (#675)
2017-01-15 14:31:34 +01:00
[![](https://images.microbadger.com/badges/image/gitea/gitea.svg)](https://microbadger.com/images/gitea/gitea "Get your own image badge on microbadger.com")
add codecov.io service. (#2493) * add codecov.io service. Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * update Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * only PR or master branch (for coverage badge) Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * update Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * update init Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2017-09-13 14:57:55 +02:00
[![codecov](https://codecov.io/gh/go-gitea/gitea/branch/master/graph/badge.svg)](https://codecov.io/gh/go-gitea/gitea)
Updated badges for drone and similar to lgtm
2016-11-24 21:43:05 +01:00
[![Go Report Card](https://goreportcard.com/badge/code.gitea.io/gitea)](https://goreportcard.com/report/code.gitea.io/gitea)
[![GoDoc](https://godoc.org/code.gitea.io/gitea?status.svg)](https://godoc.org/code.gitea.io/gitea)
Fix release tag on README (#3945)
2018-05-10 22:38:57 +02:00
[![GitHub release](https://img.shields.io/github/release/go-gitea/gitea.svg)](https://github.com/go-gitea/gitea/releases/latest)
Add CodeTriage link to README (#3299)
2018-01-09 00:01:08 +01:00
[![Help Contribute to Open Source](https://www.codetriage.com/go-gitea/gitea/badges/users.svg)](https://www.codetriage.com/go-gitea/gitea)
Fix backers badge (#8399)
2019-10-07 21:51:54 +02:00
[![Become a backer/sponsor of gitea](https://opencollective.com/gitea/tiers/backers/badge.svg?label=backers&color=brightgreen)](https://opencollective.com/gitea)
README: add License shield (#8235)
2019-09-19 04:01:38 +02:00
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
add crowdin badge (#8447)
2019-10-10 04:16:58 +02:00
[![Crowdin](https://badges.crowdin.net/gitea/localized.svg)](https://crowdin.com/project/gitea)
Adds a TODOs Badge to the README (#11999) Closes #11210 Co-authored-by: Lauris BH <lauris@nix.lv>
2020-06-22 00:19:44 +02:00
[![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)
Update README
2014-03-13 07:55:14 +01:00
Init commit
2014-02-12 18:49:46 +01:00
## Purpose
Wrap most paragraphs to 80 columns (#2396) Reduces patches size and makes them more readable
2017-08-30 03:27:23 +02: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 12:23:55 +01:00
[Gogs](https://gogs.io) since 2016.11 but changed a lot.
update README
2015-10-29 08:21:59 +01: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 14:38:49 +01:00
## Building
typo and README
2015-09-12 15:21:09 +02: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 14:38:49 +01:00
From the root of the source tree, run:
Init commit
2014-02-12 18:49:46 +01: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-08 17:56:59 +01:00
TAGS="bindata" make build
Init commit
2014-02-12 18:49:46 +01: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 03:30:02 +01: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 10:15:11 +01: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-04 20:12:01 +02: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 12:37:01 +02: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 10:15:11 +01: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-10 19:05:15 +02: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 10:15:11 +01:00
Add note to README about make parallelism (#12378) Alternative to https://github.com/go-gitea/gitea/pull/12367
2020-07-30 23:21:59 +02: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 14:38:49 +01: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 01:18:28 +01:00
support with [documentation](https://try.gitea.io/api/swagger).
Init commit
2014-02-12 18:49:46 +01:00
Dropped always outdated contributors file, link to it the graph on readme
2016-11-28 14:34:06 +01: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 14:38:49 +01: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 14:56:46 +01: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).
The hugo-based documentationt theme is hosted at [gitea/theme](https://gitea.com/gitea/theme).
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 14:34:06 +01: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 15:05:24 +01: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-27 17:34:12 +01: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 07:53:23 +02: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 02:15:32 +02: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-08 22:41:31 +02: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-27 17:34:12 +01:00
## License
Wrap most paragraphs to 80 columns (#2396) Reduces patches size and makes them more readable
2017-08-30 03:27:23 +02: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 02:13:41 +02: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 01:12:58 +01: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 02:13:41 +02: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 01:12:58 +01: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 a new issue Copy permalink