forgejo/README.md

67 lines
3.2 KiB
Markdown
Raw Normal View History

2014-03-27 01:31:01 +09:00
Gogs - Go Git Service [![wercker status](https://app.wercker.com/status/ad0bdb0bc450ac6f09bc56b9640a50aa/s/ "wercker status")](https://app.wercker.com/project/bykey/ad0bdb0bc450ac6f09bc56b9640a50aa) [![Build Status](https://drone.io/github.com/gogits/gogs/status.png)](https://drone.io/github.com/gogits/gogs/latest)
=====================
2014-03-23 09:25:39 +09:00
Gogs(Go Git Service) is a Self Hosted Git Service in the Go Programming Language.
2014-03-15 23:29:18 +09:00
2014-03-23 09:25:39 +09:00
![Demo](http://gowalker.org/public/gogs_demo.gif)
2014-02-13 02:49:46 +09:00
##### Current version: 0.2.0 Alpha
2014-03-13 15:55:14 +09:00
2014-03-29 23:01:52 +09:00
#### Due to testing purpose, data of [try.gogits.org](http://try.gogits.org) has been reset in March 29, 2014 and will reset multiple times after. Please do NOT put your important data on the site.
2014-03-23 19:27:01 +09:00
#### Other language version
- [简体中文](README_ZH.md)
2014-03-23 09:25:39 +09:00
2014-02-13 02:49:46 +09:00
## Purpose
2014-03-23 09:25:39 +09:00
Since we choose to use pure Go implementation of Git manipulation, Gogs certainly supports **ALL platforms** that Go supports, including Linux, Mac OS X, and Windows with **ZERO** dependency.
More importantly, Gogs only needs one binary to setup your own project hosting on the fly!
2014-02-13 02:49:46 +09:00
2014-02-15 08:16:54 +09:00
## Overview
2014-03-27 20:26:03 +09:00
- Please see [Wiki](https://github.com/gogits/gogs/wiki) for project design, known issues, change log and road map.
2014-03-26 04:12:23 +09:00
- See [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
2014-03-21 05:04:56 +09:00
- Try it before anything? Do it [online](http://try.gogits.org/Unknown/gogs) or go down to **Installation -> Install from binary** section!
2014-03-20 16:24:17 +09:00
- Having troubles? Get help from [Troubleshooting](https://github.com/gogits/gogs/wiki/Troubleshooting).
2014-02-15 08:16:54 +09:00
2014-03-12 08:25:50 +09:00
## Features
2014-03-16 15:28:24 +09:00
- Activity timeline
2014-03-28 00:37:33 +09:00
- SSH/HTTPS(Clone only) protocol support.
2014-03-12 08:25:50 +09:00
- Register/delete account.
2014-03-23 09:25:39 +09:00
- Create/delete/watch public repository.
2014-03-16 23:35:25 +09:00
- User profile page.
- Repository viewer.
2014-03-26 03:04:57 +09:00
- Gravatar and cache support.
2014-03-26 22:22:08 +09:00
- Mail service(register, issue).
2014-03-21 14:48:10 +09:00
- Administration panel.
2014-03-21 14:09:22 +09:00
- Supports MySQL, PostgreSQL and SQLite3(binary release only).
2014-03-12 08:25:50 +09:00
2014-02-15 08:16:54 +09:00
## Installation
2014-03-12 13:19:45 +09:00
Make sure you install [Prerequirements](https://github.com/gogits/gogs/wiki/Prerequirements) first.
2014-03-12 00:40:47 +09:00
There are two ways to install Gogs:
2014-02-15 08:16:54 +09:00
2014-03-19 08:14:58 +09:00
- [Install from binary](https://github.com/gogits/gogs/wiki/Install-from-binary): **STRONGLY RECOMMENDED** for just try and deployment!
2014-03-12 00:40:47 +09:00
- [Install from source](https://github.com/gogits/gogs/wiki/Install-from-source)
2014-02-15 08:16:54 +09:00
2014-02-13 02:49:46 +09:00
## Acknowledgments
2014-03-24 20:36:38 +09:00
- Logo is inspired by [martini-contrib](https://github.com/martini-contrib).
- Router and middleware mechanism of [martini](http://martini.codegangsta.io/).
2014-03-23 06:59:22 +09:00
- Mail Service, modules design is inspired by [WeTalk](https://github.com/beego/wetalk).
- System Monitor Status is inspired by [GoBlog](https://github.com/fuxiaohei/goblog).
2014-03-24 20:36:38 +09:00
- Usage and modification from [beego](http://beego.me) modules.
2014-03-25 00:44:47 +09:00
- Thanks [gobuild.io](http://gobuild.io) for providing binary compile and download service.
2014-02-13 02:49:46 +09: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.
## License
2014-03-28 01:48:29 +09:00
Gogs is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text.