forgejo/README.md

47 lines
2.3 KiB
Markdown
Raw Normal View History

2014-03-11 16:40:47 +01:00
Gogs - Go Git Service [![wercker status](https://app.wercker.com/status/ad0bdb0bc450ac6f09bc56b9640a50aa/s/ "wercker status")](https://app.wercker.com/project/bykey/ad0bdb0bc450ac6f09bc56b9640a50aa) [![Go Walker](http://gowalker.org/api/v1/badge)](https://gowalker.org/github.com/gogits/gogs)
2014-02-12 18:49:46 +01:00
=====================
2014-02-12 03:01:43 +01:00
2014-03-15 15:29:18 +01:00
Gogs(Go Git Service) is a GitHub-like clone in the Go Programming Language.
2014-03-17 16:56:50 +01:00
Since we choose to use pure Go implementation of Git manipulation, Gogs certainly supports **ALL platforms** that Go supports, including Linux, Max OS X, and Windows with **ZERO** dependency.
2014-02-12 18:49:46 +01:00
2014-03-17 19:11:46 +01:00
##### Current version: 0.1.0 Alpha
2014-03-13 07:55:14 +01:00
2014-02-12 18:49:46 +01:00
## Purpose
There are some very good products in this category such as [gitlab](http://gitlab.com), but the environment setup steps often make us crazy. So our goal of Gogs is to build a GitHub-like clone with very easy setup steps, which take advantages of the Go Programming Language.
2014-02-15 00:16:54 +01:00
## Overview
- Please see [Wiki](https://github.com/gogits/gogs/wiki) for project design, develop specification, change log and road map.
- See [Trello Broad](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
2014-03-19 00:14:58 +01:00
- Try it before anything? Go down to **Installation -> Install from binary** section!.
2014-02-15 00:16:54 +01:00
2014-03-12 00:25:50 +01:00
## Features
2014-03-16 07:28:24 +01:00
- Activity timeline
2014-03-17 16:56:50 +01:00
- SSH protocol support.
2014-03-12 00:25:50 +01:00
- Register/delete account.
2014-03-13 07:55:14 +01:00
- Create/delete public repository.
2014-03-16 15:35:25 +01:00
- User profile page.
- Repository viewer.
- Gravatar support.
- Supports MySQL and PostgreSQL.
2014-03-12 00:25:50 +01:00
2014-02-15 00:16:54 +01:00
## Installation
2014-03-12 05:19:45 +01:00
Make sure you install [Prerequirements](https://github.com/gogits/gogs/wiki/Prerequirements) first.
2014-03-11 16:40:47 +01:00
There are two ways to install Gogs:
2014-02-15 00:16:54 +01:00
2014-03-19 00:14:58 +01:00
- [Install from binary](https://github.com/gogits/gogs/wiki/Install-from-binary): **STRONGLY RECOMMENDED** for just try and deployment!
2014-03-11 16:40:47 +01:00
- [Install from source](https://github.com/gogits/gogs/wiki/Install-from-source)
2014-02-15 00:16:54 +01:00
2014-02-12 18:49:46 +01:00
## Acknowledgments
2014-03-19 13:27:27 +01:00
- Mail service is based on [WeTalk](https://github.com/beego/wetalk).
2014-03-19 15:01:45 +01:00
- Logo is inspired by [martini](https://github.com/martini-contrib).
2014-02-12 18:49:46 +01:00
## Contributors
This project was launched by [Unknown](https://github.com/Unknwon) and [lunny](https://github.com/lunny); [fuxiaohei](https://github.com/fuxiaohei) and [slene](https://github.com/slene) joined the team soon after. See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.