aniani/gitea
1
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2024-11-04 08:17:24 -05:00
Code
5115c278ff
gitea/README.md

140 lines
8.0 KiB
Markdown
Raw Normal View History

Simplify README (#29827) Came to the conclusion that a simple format Readme is easier to read than the previous fancy centered stuff. --------- Co-authored-by: Yarden Shoham <git@yardenshoham.com>
2024-03-17 08:14:14 -04:00
# Gitea
add ZH readme (#405)
2016-12-19 08:30:52 -05:00
Simplify README (#29827) Came to the conclusion that a simple format Readme is easier to read than the previous fancy centered stuff. --------- Co-authored-by: Yarden Shoham <git@yardenshoham.com>
2024-03-17 08:14:14 -04:00
[![](https://github.com/go-gitea/gitea/actions/workflows/release-nightly.yml/badge.svg?branch=main)](https://github.com/go-gitea/gitea/actions/workflows/release-nightly.yml?query=branch%3Amain "Release Nightly")
[![](https://img.shields.io/discord/322538954119184384.svg?logo=discord&logoColor=white&label=Discord&color=5865F2)](https://discord.gg/Gitea "Join the Discord chat at https://discord.gg/Gitea")
[![](https://goreportcard.com/badge/code.gitea.io/gitea)](https://goreportcard.com/report/code.gitea.io/gitea "Go Report Card")
[![](https://pkg.go.dev/badge/code.gitea.io/gitea?status.svg)](https://pkg.go.dev/code.gitea.io/gitea "GoDoc")
[![](https://img.shields.io/github/release/go-gitea/gitea.svg)](https://github.com/go-gitea/gitea/releases/latest "GitHub release")
[![](https://www.codetriage.com/go-gitea/gitea/badges/users.svg)](https://www.codetriage.com/go-gitea/gitea "Help Contribute to Open Source")
[![](https://opencollective.com/gitea/tiers/backers/badge.svg?label=backers&color=brightgreen)](https://opencollective.com/gitea "Become a backer/sponsor of gitea")
[![](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT "License: MIT")
README Badge maintenance (#31441) 1. Remove tickgit badge, the service [only gives errors](https://www.tickgit.com/browse?repo=github.com/go-gitea/gitea&branch=main) and the repo [seems unmaintained](https://github.com/augmentable-dev/tickgit). 2. Color the gitpod badge green because grey badges look odd.
2024-06-21 09:18:39 -04:00
[![Contribute with Gitpod](https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod&color=green)](https://gitpod.io/#https://github.com/go-gitea/gitea)
Simplify README (#29827) Came to the conclusion that a simple format Readme is easier to read than the previous fancy centered stuff. --------- Co-authored-by: Yarden Shoham <git@yardenshoham.com>
2024-03-17 08:14:14 -04:00
[![](https://badges.crowdin.net/gitea/localized.svg)](https://crowdin.com/project/gitea "Crowdin")
Badges and travis testing (#40) * Added badges to the README * Restructured the travis config
2016-11-03 10:50:44 -04:00
Simplify README (#29827) Came to the conclusion that a simple format Readme is easier to read than the previous fancy centered stuff. --------- Co-authored-by: Yarden Shoham <git@yardenshoham.com>
2024-03-17 08:14:14 -04:00
[View this document in Chinese](./README_ZH.md)
Update README
2014-03-13 02:55:14 -04:00
Init commit
2014-02-12 12:49:46 -05:00
## Purpose
Wrap most paragraphs to 80 columns (#2396) Reduces patches size and makes them more readable
2017-08-29 21:27:23 -04:00
The goal of this project is to make the easiest, fastest, and most
painless way of setting up a self-hosted Git service.
Fix English mistakes in some Markdown documents (#20274)
2022-07-14 07:15:35 -04:00
As Gitea is written in Go, it works across **all** the platforms and
architectures that are supported by Go, including Linux, macOS, and
Windows on x86, amd64, ARM and PowerPC architectures.
Wrap most paragraphs to 80 columns (#2396) Reduces patches size and makes them more readable
2017-08-29 21:27:23 -04:00
This project has been
Update blog links (#25843) As title. Permalinks for lastest version of blog has changed, update the blog links. --------- Co-authored-by: Giteabot <teabot@gitea.io>
2023-07-12 07:35:07 -04:00
[forked](https://blog.gitea.com/welcome-to-gitea/) from
Fix English mistakes in some Markdown documents (#20274)
2022-07-14 07:15:35 -04:00
[Gogs](https://gogs.io) since November of 2016, but a lot has changed.
update README
2015-10-29 03:21:59 -04:00
Update demo site location from try.gitea.io -> demo.gitea.com (#31054)
2024-05-27 11:05:12 -04:00
For online demonstrations, you can visit [demo.gitea.com](https://demo.gitea.com).
Add more ways to try (#28581)
2023-12-22 01:20:59 -05:00
For accessing free Gitea service (with a limited number of repositories), you can visit [gitea.com](https://gitea.com/user/login).
To quickly deploy your own dedicated Gitea instance on Gitea Cloud, you can start a free trial at [cloud.gitea.com](https://cloud.gitea.com).
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 08:38:49 -05:00
## Building
typo and README
2015-09-12 09:21:09 -04: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 08:38:49 -05:00
From the root of the source tree, run:
Init commit
2014-02-12 12:49:46 -05: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 11:56:59 -05:00
TAGS="bindata" make build
Init commit
2014-02-12 12:49:46 -05:00
Fix various typos of software names (#18083) * `git` -> `Git` * `Github` and `github` -> `GitHub` * `crowdin` -> `Crowdin` * `git-lfs` -> `Git LFS` * `githooks`, `git hooks`, `git-hooks` -> `Git Hooks` * `discord` -> `Discord` * `2fa` -> `2FA` * `gitlab` and `Gitlab` -> `GitLab` * `web hook` -> `webhook` * `linux` -> `Linux` * `sqlite` -> `SQLite` * `MYSQL` and `mysql` -> `MySQL` * rename refs to `master` branch -> `main` * Fix English grammar
2021-12-23 22:56:57 -05:00
or if SQLite support is required:
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-28 21:30:02 -05:00
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 04:15:11 -05:00
The `build` target is split into two sub-targets:
Update info regarding internet connection for build (#26776) This build info was outdated since we no longer vendor go modules. Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
2023-08-29 05:09:44 -04:00
- `make backend` which requires [Go Stable](https://go.dev/dl/), the required version is defined in [go.mod](/go.mod).
- `make frontend` which requires [Node.js LTS](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 04:15:11 -05:00
Update info regarding internet connection for build (#26776) This build info was outdated since we no longer vendor go modules. Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
2023-08-29 05:09:44 -04:00
Internet connectivity is required to download the go and npm modules. When building from the official source tarballs which include pre-built frontend files, the `frontend` target will not be triggered, making it possible to build without Node.js.
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 04:15:11 -05:00
Use docs.gitea.com instead of docs.gitea.io (#26739)
2023-08-27 07:59:12 -04:00
More info: https://docs.gitea.com/installation/install-from-source
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 08:38:49 -05:00
## Using
./gitea web
Use Markdown alert syntax for notes in README (#29150) - It looks nicer - This syntax is supported on both GitHub and Gitea Signed-off-by: Yarden Shoham <git@yardenshoham.com>
2024-02-12 16:14:24 -05:00
> [!NOTE]
Update demo site location from try.gitea.io -> demo.gitea.com (#31054)
2024-05-27 11:05:12 -04:00
> If you're interested in using our APIs, we have experimental support with [documentation](https://docs.gitea.com/api).
Init commit
2014-02-12 12:49:46 -05:00
Dropped always outdated contributors file, link to it the graph on readme
2016-11-28 08:34:06 -05: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 08:38:49 -05:00
Expected workflow is: Fork -> Patch -> Push -> Pull Request
Use Markdown alert syntax for notes in README (#29150) - It looks nicer - This syntax is supported on both GitHub and Gitea Signed-off-by: Yarden Shoham <git@yardenshoham.com>
2024-02-12 16:14:24 -05:00
> [!NOTE]
>
> 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!
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 08:38:49 -05:00
Update README.md | Add translation section (#15830) * Update README.md * chinese translation Signed-off-by: a1012112796 <1012112796@qq.com> * Update README.md * Update README.md * Update README.md Co-authored-by: a1012112796 <1012112796@qq.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2021-05-12 11:02:55 -04:00
## Translating
Add markdownlint (#20512) Add `markdownlint` linter and fix issues. Config is based on the one from electron's repo with a few rules relaxed.
2022-07-27 21:22:47 -04:00
Translations are done through Crowdin. If you want to translate to a new language ask one of the managers in the Crowdin project to add a new language there.
Update README.md | Add translation section (#15830) * Update README.md * chinese translation Signed-off-by: a1012112796 <1012112796@qq.com> * Update README.md * Update README.md * Update README.md Co-authored-by: a1012112796 <1012112796@qq.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2021-05-12 11:02:55 -04:00
Fix various typos (#20338) * Fix various typos Found via `codespell -q 3 -S ./options/locale,./options/license,./public/vendor -L actived,allways,attachements,ba,befores,commiter,pullrequest,pullrequests,readby,splitted,te,unknwon` Co-authored-by: zeripath <art27@cantab.net>
2022-07-12 17:32:37 -04:00
You can also just create an issue for adding a language or ask on discord on the #translation channel. If you need context or find some translation issues, you can leave a comment on the string or ask on Discord. For general translation questions there is a section in the docs. Currently a bit empty but we hope to fill it as questions pop up.
Update README.md | Add translation section (#15830) * Update README.md * chinese translation Signed-off-by: a1012112796 <1012112796@qq.com> * Update README.md * Update README.md * Update README.md Co-authored-by: a1012112796 <1012112796@qq.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2021-05-12 11:02:55 -04:00
cynkra is covered via oc links now (#26641)
2023-08-21 13:16:23 -04:00
https://docs.gitea.com/contributing/localization
Update README.md | Add translation section (#15830) * Update README.md * chinese translation Signed-off-by: a1012112796 <1012112796@qq.com> * Update README.md * Update README.md * Update README.md Co-authored-by: a1012112796 <1012112796@qq.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2021-05-12 11:02:55 -04:00
[![Crowdin](https://badges.crowdin.net/gitea/localized.svg)](https://crowdin.com/project/gitea)
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 08:38:49 -05:00
## Further information
cynkra is covered via oc links now (#26641)
2023-08-21 13:16:23 -04:00
For more information and instructions about how to install Gitea, please look at our [documentation](https://docs.gitea.com/).
Update demo site location from try.gitea.io -> demo.gitea.com (#31054)
2024-05-27 11:05:12 -04:00
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://forum.gitea.com/).
README: Add more contents to the "further information" section. (#13871)
2020-12-06 08:56:46 -05:00
Add markdownlint (#20512) Add `markdownlint` linter and fix issues. Config is based on the one from electron's repo with a few rules relaxed.
2022-07-27 21:22:47 -04:00
We maintain a list of Gitea-related projects at [gitea/awesome-gitea](https://gitea.com/gitea/awesome-gitea).
README: Add more contents to the "further information" section. (#13871)
2020-12-06 08:56:46 -05: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 08:34:06 -05:00
## Authors
Add markdownlint (#20512) Add `markdownlint` linter and fix issues. Config is based on the one from electron's repo with a few rules relaxed.
2022-07-27 21:22:47 -04:00
- [Maintainers](https://github.com/orgs/go-gitea/people)
- [Contributors](https://github.com/go-gitea/gitea/graphs/contributors)
- [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 12:34:12 -04: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 01:53:23 -04: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-04 20:15:32 -04: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 16:41:31 -04: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 12:34:12 -04:00
## License
Wrap most paragraphs to 80 columns (#2396) Reduces patches size and makes them more readable
2017-08-29 21:27:23 -04:00
This project is licensed under the MIT License.
update branch in CI and docs (#15631)
2021-05-04 12:16:23 -04:00
See the [LICENSE](https://github.com/go-gitea/gitea/blob/main/LICENSE) file
Wrap most paragraphs to 80 columns (#2396) Reduces patches size and makes them more readable
2017-08-29 21:27:23 -04:00
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-08 20:13:41 -04:00
## Screenshots
Add markdownlint (#20512) Add `markdownlint` linter and fix issues. Config is based on the one from electron's repo with a few rules relaxed.
2022-07-27 21:22:47 -04:00
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-08 20:13:41 -04:00
Looking for an overview of the interface? Check it out!
Use the new download domain replace the old (#25405) As title.
2023-06-20 23:11:17 -04:00
|![Dashboard](https://dl.gitea.com/screenshots/home_timeline.png)|![User Profile](https://dl.gitea.com/screenshots/user_profile.png)|![Global Issues](https://dl.gitea.com/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-08 20:13:41 -04:00
|:---:|:---:|:---:|
Use the new download domain replace the old (#25405) As title.
2023-06-20 23:11:17 -04:00
|![Branches](https://dl.gitea.com/screenshots/branches.png)|![Web Editor](https://dl.gitea.com/screenshots/web_editor.png)|![Activity](https://dl.gitea.com/screenshots/activity.png)|
Update JS and PY dependencies, build for `es2020` browsers (#28977) - Update all JS dependencies minus @mcaptcha/vanilla-glue - Fix new lint errors - Regenerate SVGs - Switch to maintained stylelint stylistic plugin - Tested Mermaid, Citation, Swagger, sorting - Raise ESBuild target to `es2020` as dictated by `pretty-ms` dependency.
2024-02-02 04:36:32 -05:00
|![New Migration](https://dl.gitea.com/screenshots/migration.png)|![Migrating](https://dl.gitea.com/screenshots/migration.gif)|![Pull Request View](https://image.ibb.co/e02dSb/6.png)|
|![Pull Request Dark](https://dl.gitea.com/screenshots/pull_requests_dark.png)|![Diff Review Dark](https://dl.gitea.com/screenshots/review_dark.png)|![Diff Dark](https://dl.gitea.com/screenshots/diff_dark.png)|
Copy Permalink