forgejo-federation/README.md

49 lines
2.4 KiB
Markdown
Raw Normal View History

2014-03-11 21:10:47 +05:30
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 23:19:46 +05:30
=====================
2014-02-12 07:31:43 +05:30
2014-03-15 19:59:18 +05:30
Gogs(Go Git Service) is a GitHub-like clone in the Go Programming Language.
2014-03-17 21:26:50 +05:30
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 23:19:46 +05:30
2014-03-20 06:35:48 +05:30
##### Current version: 0.1.1 Alpha
2014-03-13 12:25:14 +05:30
2014-02-12 23:19:46 +05:30
## 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 04:46:54 +05:30
## 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 04:44:58 +05:30
- Try it before anything? Go down to **Installation -> Install from binary** section!.
2014-03-20 12:54:17 +05:30
- Having troubles? Get help from [Troubleshooting](https://github.com/gogits/gogs/wiki/Troubleshooting).
2014-02-15 04:46:54 +05:30
2014-03-12 04:55:50 +05:30
## Features
2014-03-16 11:58:24 +05:30
- Activity timeline
2014-03-17 21:26:50 +05:30
- SSH protocol support.
2014-03-12 04:55:50 +05:30
- Register/delete account.
2014-03-13 12:25:14 +05:30
- Create/delete public repository.
2014-03-16 20:05:25 +05:30
- User profile page.
- Repository viewer.
- Gravatar support.
2014-03-20 06:35:48 +05:30
- Mail service(register).
- Supports MySQL and PostgreSQL.
2014-03-12 04:55:50 +05:30
2014-02-15 04:46:54 +05:30
## Installation
2014-03-12 09:49:45 +05:30
Make sure you install [Prerequirements](https://github.com/gogits/gogs/wiki/Prerequirements) first.
2014-03-11 21:10:47 +05:30
There are two ways to install Gogs:
2014-02-15 04:46:54 +05:30
2014-03-19 04:44:58 +05:30
- [Install from binary](https://github.com/gogits/gogs/wiki/Install-from-binary): **STRONGLY RECOMMENDED** for just try and deployment!
2014-03-11 21:10:47 +05:30
- [Install from source](https://github.com/gogits/gogs/wiki/Install-from-source)
2014-02-15 04:46:54 +05:30
2014-02-12 23:19:46 +05:30
## Acknowledgments
2014-03-19 17:57:27 +05:30
- Mail service is based on [WeTalk](https://github.com/beego/wetalk).
2014-03-19 19:31:45 +05:30
- Logo is inspired by [martini](https://github.com/martini-contrib).
2014-02-12 23:19:46 +05:30
## 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.