Skip to content

Commit c040f2f

Browse files
xinitystrk
authored andcommitted
first batch of Readme updates (#65)
1 parent 94b2747 commit c040f2f

File tree

5 files changed

+15
-25
lines changed

5 files changed

+15
-25
lines changed

README.md

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@
77
[![](https://images.microbadger.com/badges/image/gitea/gitea.svg)](http://microbadger.com/images/gitea/gitea "Get your own image badge on microbadger.com")
88
[![Join the chat at https://gitter.im/go-gitea/gitea](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/go-gitea/gitea?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
99

10-
![](https://github.com/go-gitea/gitea/blob/master/public/img/gogs-large-resize.png?raw=true)
10+
![](https://github.com/go-gitea/gitea/blob/master/public/img/gitea-large-resize.png?raw=true)
1111

12-
##### Current tip version: 0.9.99 (see [Releases](https://github.com/go-gitea/gitea/releases) for binary versions or submit a task on [alpha stage automated binary building system](https://build.gogs.io/))
12+
##### Status
13+
14+
**Current version**: (see [Releases](https://github.com/go-gitea/gitea/releases))
1315

1416
| Web | UI | Preview |
1517
|:-------------:|:-------:|:-------:|
@@ -19,25 +21,14 @@
1921

2022
### Important Notes
2123

22-
1. **YOU MUST READ [Contributing Code](https://github.com/go-gitea/gitea/wiki/Contributing-Code) BEFORE STARTING TO WORK ON A PULL REQUEST**.
23-
2. Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) was reset in **Jan 28, 2015** and will reset multiple times after. Please do **NOT** put your important data on the site.
24-
3. The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
25-
4. If you think there are vulnerabilities in the project, please talk privately to **[email protected]**. Thanks!
26-
5. If you're interested in using APIs, we have experimental support with [documentation](https://godoc.org/github.com/go-gitea/go-sdk).
27-
6. If your team/company is using Gogs and would like to put your logo on [our website](https://gogs.io), contact us by any means.
24+
1. **YOU MUST READ THE [Contributors Guide](https://github.com/go-gitea/gitea/CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST**.
25+
2. If you think there are vulnerabilities in the project, please talk privately to **[email protected]**. Thanks!
26+
3. If you're interested in using APIs, we have experimental support with [documentation](https://godoc.org/github.com/go-gitea/go-sdk).
2827

2928
## Purpose
3029

3130
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.
3231

33-
## Overview
34-
35-
- Please see the [Documentation](https://gogs.io/docs/intro) for common usages and change log.
36-
- See the [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
37-
- Want to try it before doing anything else? Do it [online](https://try.gogs.io/gogs/gogs)!
38-
- Having trouble? Get help with [Troubleshooting](https://gogs.io/docs/intro/troubleshooting.html) or [User Forum](https://discuss.gogs.io/).
39-
- Want to help with localization? Check out the [guide](https://gogs.io/docs/features/i18n.html)!
40-
4132
## Features
4233

4334
- Activity timeline
@@ -69,15 +60,14 @@ The goal of this project is to make the easiest, fastest, and most painless way
6960

7061
## Installation
7162

72-
Make sure you install the [prerequisites](https://gogs.io/docs/installation) first.
63+
**Note: As Gitea is a [Gogs](https://github.com/gogits/gogs) fork, tutorials and documentation related to gogs applies to Gitea too**
7364

74-
There are 5 ways to install Gogs:
65+
How to install Gitea:
7566

76-
- [Install from binary](https://gogs.io/docs/installation/install_from_binary.html)
77-
- [Install from source](https://gogs.io/docs/installation/install_from_source.html)
78-
- [Install from packages](https://gogs.io/docs/installation/install_from_packages.html)
7967
- [Ship with Docker](https://github.com/go-gitea/gitea/tree/master/docker)
80-
- [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
68+
- [Install with Vagrant](https://github.com/go-gitea/examples/tree/master/vagrant)
69+
70+
**Note: binary release will be available soon**
8171

8272
### Tutorials
8373

@@ -133,9 +123,9 @@ There are 5 ways to install Gogs:
133123

134124
## Contributors
135125

136-
- Ex-team members [@lunny](https://github.com/lunny), [@fuxiaohei](https://github.com/fuxiaohei) and [@slene](https://github.com/slene).
137-
- See [contributors page](https://github.com/go-gitea/gitea/graphs/contributors) for full list of contributors.
138-
- See [TRANSLATORS](conf/locale/TRANSLATORS) for public list of translators.
126+
- See [Maintainer](https://github.com/orgs/go-gitea/people)
127+
- See [Contributors](https://github.com/go-gitea/gitea/graphs/contributors) for full list of contributors.
128+
- See [Translators](conf/locale/TRANSLATORS) for public list of translators.
139129

140130
## License
141131

public/img/avatar_default.png

30.4 KB
Loading

public/img/favicon.png

11.6 KB
Loading

public/img/gitea-large-resize.png

48 KB
Loading

public/img/gitea-lg.png

80.5 KB
Loading

0 commit comments

Comments
 (0)