Browse Source

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
Thomas Boerger 3 years ago
parent
commit
770e8310bd
1 changed files with 9 additions and 107 deletions
  1. 9 107
      README.md

+ 9 - 107
README.md

@@ -8,12 +8,7 @@
8 8
 [![Coverage Status](https://coverage.gitea.io/badges/go-gitea/gitea/coverage.svg)](https://coverage.gitea.io/go-gitea/gitea)
9 9
 [![Go Report Card](https://goreportcard.com/badge/code.gitea.io/gitea)](https://goreportcard.com/report/code.gitea.io/gitea)
10 10
 [![GoDoc](https://godoc.org/code.gitea.io/gitea?status.svg)](https://godoc.org/code.gitea.io/gitea)
11
-
12
-[![](public/img/gitea-large-resize.png)](https://github.com/go-gitea/gitea)
13
-
14
-##### Status
15
-
16
-**Current version**: (see [Releases](https://github.com/go-gitea/gitea/releases))
11
+[![Release](http://github-release-version.herokuapp.com/github/go-gitea/gitea/release.svg?style=flat)](https://github.com/go-gitea/gitea/releases/latest)
17 12
 
18 13
 ||||
19 14
 |:-------------:|:-------:|:-------:|
@@ -22,112 +17,19 @@
22 17
 |![Issues](https://i.imgur.com/xCYRqaF.jpg)|![Releases](https://i.imgur.com/ILpRBCe.jpg)|![Organization](https://i.imgur.com/0BHnrcL.jpg)|
23 18
 ||||
24 19
 
25
-### Important Notes
26
-
27
-1. **YOU MUST READ THE [Contributors Guide](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST**.
28
-2. If you think there are vulnerabilities in the project, please talk privately to **security@gitea.io**. Thanks!
29
-3. If you're interested in using APIs, we have experimental support with [documentation](https://godoc.org/github.com/go-gitea/go-sdk).
30
-
31 20
 ## Purpose
32 21
 
33
-The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. With Go, this can be done with an independent binary distribution across **ALL platforms** that Go supports, including Linux, Mac OS X, Windows and ARM.
34
-
35
-Want to try it before doing anything else?
36
-Do it [online](https://try.gitea.io/)!
37
-
38
-## Features
39
-
40
-- Activity timeline
41
-- SSH and HTTP/HTTPS protocols
42
-- SMTP/LDAP/Reverse proxy authentication
43
-- Reverse proxy with sub-path
44
-- Account/Organization/Repository management
45
-- Add/Remove repository collaborators
46
-- Repository/Organization webhooks (including Slack)
47
-- Repository Git hooks/deploy keys
48
-- Repository issues, pull requests and wiki
49
-- Migrate and mirror repository and its wiki
50
-- Web editor for repository files and wiki
51
-- Gravatar and Federated avatar with custom source
52
-- Mail service
53
-- Administration panel
54
-- Supports MySQL, PostgreSQL, SQLite3 and [TiDB](https://github.com/pingcap/tidb) (experimental)
55
-- Multi-language support ([21 languages](https://crowdin.com/project/gogs))
56
-
57
-## System Requirements
58
-
59
-- A cheap Raspberry Pi is powerful enough for basic functionality.
60
-- 2 CPU cores and 1GB RAM would be the baseline for teamwork.
61
-
62
-## Browser Support
63
-
64
-- Please see [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) for specific versions of supported browsers.
65
-- The official support minimal size  is **1024*768**, UI may still looks right in smaller size but no promises and fixes.
66
-
67
-## Installation
68
-
69
-**Note: As Gitea is a [Gogs](https://github.com/gogits/gogs) fork, tutorials and documentation related to gogs applies to Gitea too**
70
-
71
-How to install Gitea:
72
-
73
-- go get code.gitea.io/gitea
74
-- [Ship with Docker](https://github.com/go-gitea/gitea/tree/master/docker)
75
-- [Install with Vagrant](https://github.com/go-gitea/examples/tree/master/vagrant)
76
-
77
-**Note: binary release will be available soon**
78
-
79
-### Tutorials
80
-
81
-- [How To Set Up Gogs on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-set-up-gogs-on-ubuntu-14-04)
82
-- [Run your own GitHub-like service with the help of Docker](http://blog.hypriot.com/post/run-your-own-github-like-service-with-docker/)
83
-- [Dockerized Gogs git server and alpine postgres in 20 minutes or less](http://garthwaite.org/docker-gogs.html)
84
-- [Host Your Own Private GitHub with Gogs.io](https://eladnava.com/host-your-own-private-github-with-gogs-io/)
85
-- [使用 Gogs 搭建自己的 Git 服务器](https://mynook.info/blog/post/host-your-own-git-server-using-gogs) (Chinese)
86
-- [阿里云上 Ubuntu 14.04 64 位安装 Gogs](http://my.oschina.net/luyao/blog/375654) (Chinese)
87
-- [Installing Gogs on FreeBSD](https://www.codejam.info/2015/03/installing-gogs-on-freebsd.html)
88
-- [Gogs on Raspberry Pi](http://blog.meinside.pe.kr/Gogs-on-Raspberry-Pi/)
89
-- [Cloudflare Full SSL with GOGS (Go Git Service) using NGINX](http://www.listekconsulting.com/articles/cloudflare-full-ssl-with-gogs-go-git-service-using-nginx/)
90
-
91
-### Screencasts
92
-
93
-- [How to install Gogs on a Linux Server (DigitalOcean)](https://www.youtube.com/watch?v=deSfX0gqefE)
94
-- [Instalando Gogs no Ubuntu](https://www.youtube.com/watch?v=4UkHAR1F7ZA) (Português)
95
-
96
-### Deploy to Cloud
97
-
98
-- [OpenShift](https://github.com/tkisme/gogs-openshift)
99
-- [Cloudron](https://cloudron.io/appstore.html#io.gogs.cloudronapp)
100
-- [Scaleway](https://www.scaleway.com/imagehub/gogs/)
101
-- [Portal](https://portaldemo.xyz/cloud/)
102
-- [Sandstorm](https://github.com/cem/gogs-sandstorm)
103
-- [sloppy.io](https://github.com/sloppyio/quickstarters/tree/master/gogs)
104
-- [YunoHost](https://github.com/mbugeia/gogs_ynh)
105
-- [DPlatform](https://github.com/j8r/DPlatform)
106
-
107
-## Software and Service Support
108
-
109
-- [Drone](https://github.com/drone/drone) (CI)
110
-- [Fabric8](http://fabric8.io/) (DevOps)
111
-- [Taiga](https://taiga.io/) (Project Management)
112
-- [Puppet](https://forge.puppetlabs.com/Siteminds/gogs) (IT)
113
-- [Kanboard](http://kanboard.net/plugin/gogs-webhook) (Project Management)
114
-- [BearyChat](https://bearychat.com/) (Team Communication)
115
-- [HiWork](http://www.hiwork.cc/) (Team Communication)
116
-
117
-### Product Support
22
+The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. With Go, this can be done with an independent binary distribution across **all platforms** that Go supports, including Linux, macOS, and Windows. Want to try it before doing anything else? Do it [online](https://try.gitea.io/)!
118 23
 
119
-- [Synology](https://www.synology.com) (Docker)
120
-- [One Space](http://www.onespace.cc) (App Store)
24
+## Notes
121 25
 
122
-## Acknowledgments
26
+1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.**
27
+2. If you found a vulnerability in the project, please write privately to **security@gitea.io**. Thanks!
28
+3. If you're interested in using our APIs, we have experimental support with [documentation](https://godoc.org/github.com/go-gitea/go-sdk).
123 29
 
124
-- Router and middleware mechanism of [Macaron](https://github.com/go-macaron/macaron).
125
-- System Monitor Status is inspired by [GoBlog](https://github.com/fuxiaohei/goblog).
126
-- Thanks [Rocker](http://weibo.com/rocker1989) for designing Logo.
127
-- Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.
128
-- Thanks [DigitalOcean](https://www.digitalocean.com) for hosting home and demo sites.
129
-- Thanks [KeyCDN](https://www.keycdn.com/) and [QiNiu](http://www.qiniu.com/) for providing CDN service.
30
+## Docs
130 31
 
32
+For further information or instructions how to install Gitea please take a look at our [documentation](https://docs.gitea.io/en-us/), if you can not find some specific information just head over to our [Gitter](https://gitter.im/go-gitea/gitea) channel to have a chat with us.
131 33
 
132 34
 ## Contributing
133 35
 
@@ -137,7 +39,7 @@ Fork -> Patch -> Push -> Pull Request
137 39
 
138 40
 * [Maintainers](https://github.com/orgs/go-gitea/people)
139 41
 * [Contributors](https://github.com/go-gitea/gitea/graphs/contributors)
140
-* [Translators](conf/locale/TRANSLATORS)
42
+* [Translators](options/locale/TRANSLATORS)
141 43
 
142 44
 ## License
143 45