diff --git a/README.md b/README.md index fc5f1cdf7..ff8c612af 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,11 @@ |![Profile](https://gogs.io/img/screenshots/4.png)|![Diff](https://gogs.io/img/screenshots/5.png)|![Repository Settings](https://gogs.io/img/screenshots/6.png?ts=20170322)| |![Webhook](https://gogs.io/img/screenshots/7.png)|![Organization](https://gogs.io/img/screenshots/8.png)|![Admin Dashboard](https://gogs.io/img/screenshots/9.png)| -### Important Notes +### ⚠️ Important notes ⚠️ -1. **YOU MUST READ [Contributing Code](https://github.com/gogs/gogs/wiki/Contributing-Code) BEFORE STARTING TO WORK ON A PULL REQUEST**. -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. -3. The demo site [try.gogs.io](https://try.gogs.io) is running under `master` branch. -4. If you're interested in using APIs, we have experimental support with [documentation](https://github.com/gogs/go-gogs-client/wiki). +1. 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. +2. The demo site [try.gogs.io](https://try.gogs.io) is running `master` branch. +3. If you're interested in using APIs, we have experimental support with [documentation](https://github.com/gogs/go-gogs-client/wiki). [简体中文](README_ZH.md) @@ -25,10 +24,11 @@ The Gogs (`/gɑgz/`) project aims to build a simple, stable and extensible self- ## Overview -- Please see the [Documentation](https://gogs.io/docs/intro) for common usages and change log. +- Please visit [our home page](https://gogs.io) for user documentation. +- Please refer to [CHANGELOG.md](CHANGELOG.md) for list of changes in each releases. - Want to try it before doing anything else? Do it [online](https://try.gogs.io/gogs/gogs)! -- Having trouble? Get help with [Troubleshooting](https://gogs.io/docs/intro/troubleshooting.html) or [User Forum](https://discuss.gogs.io/). -- Want to help with localization? Check out the [guide](https://gogs.io/docs/features/i18n.html)! +- Having trouble? Help yourself with [troubleshooting](https://gogs.io/docs/intro/troubleshooting.html) or ask questions on [user forum](https://discuss.gogs.io/). +- Want to help with localization? Check out the [localization documentation](https://gogs.io/docs/features/i18n.html). ## Features @@ -46,13 +46,13 @@ The Gogs (`/gɑgz/`) project aims to build a simple, stable and extensible self- - Rich database backend, including PostgreSQL, MySQL, SQLite3, MSSQL and [TiDB](https://github.com/pingcap/tidb). - Have localization over [30 languages](https://crowdin.com/project/gogs). -## Hardware Requirements +## Hardware requirements - A Raspberry Pi or $5 Digital Ocean Droplet is more than enough to get you started. Some even use 64MB RAM Docker [CaaS](https://blog.docker.com/2016/02/containers-as-a-service-caas/). - 2 CPU cores and 512MB RAM would be the baseline for teamwork. - Increase CPU cores when your team size gets significantly larger, memory footprint remains low. -## Browser Support +## Browser support - Please see [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) for specific versions of supported browsers. - The smallest resolution officially supported is **1024*768**, however the UI may still look right in smaller resolutions, but no promises or fixes. @@ -70,24 +70,7 @@ There are 6 ways to install Gogs: - [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs) - [Install with Kubernetes Using Helm Charts](https://github.com/helm/charts/tree/master/incubator/gogs) -### Tutorials - -- [How To Set Up Gogs on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-set-up-gogs-on-ubuntu-14-04) -- [Run your own GitHub-like service with the help of Docker](http://blog.hypriot.com/post/run-your-own-github-like-service-with-docker/) -- [Dockerized Gogs git server and alpine postgres in 20 minutes or less](http://garthwaite.org/docker-gogs.html) -- [Host Your Own Private GitHub with Gogs](https://eladnava.com/host-your-own-private-github-with-gogs-io/) -- [使用 Gogs 搭建自己的 Git 服务器](https://blog.mynook.info/post/host-your-own-git-server-using-gogs/) (Chinese) -- [阿里云上 Ubuntu 14.04 64 位安装 Gogs](http://my.oschina.net/luyao/blog/375654) (Chinese) -- [Installing Gogs on FreeBSD](https://www.codejam.info/2015/03/installing-gogs-on-freebsd.html) -- [Gogs on Raspberry Pi](http://blog.meinside.pe.kr/Gogs-on-Raspberry-Pi/) -- [Cloudflare Full SSL with Gogs using NGINX](http://www.listekconsulting.com/articles/cloudflare-full-ssl-with-gogs-go-git-service-using-nginx/) - -### Screencasts - -- [How to install Gogs on a Linux Server (DigitalOcean)](https://www.youtube.com/watch?v=deSfX0gqefE) -- [Instalando Gogs no Ubuntu](https://www.youtube.com/watch?v=4UkHAR1F7ZA) (Português) - -### Deploy to Cloud +### Deploy to cloud - [OpenShift](https://github.com/tkisme/gogs-openshift) - [Cloudron](https://cloudron.io/appstore.html#io.gogs.cloudronapp) @@ -98,20 +81,27 @@ There are 6 ways to install Gogs: - [DPlatform](https://github.com/j8r/DPlatform) - [LunaNode](https://github.com/LunaNode/launchgogs) -## Software and Service Support +### Tutorials + +- [How To Set Up Gogs on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-set-up-gogs-on-ubuntu-14-04) +- [Run your own GitHub-like service with the help of Docker](http://blog.hypriot.com/post/run-your-own-github-like-service-with-docker/) +- [Dockerized Gogs git server and alpine postgres in 20 minutes or less](http://garthwaite.org/docker-gogs.html) +- [Host Your Own Private GitHub with Gogs](https://eladnava.com/host-your-own-private-github-with-gogs-io/) +- [使用 Gogs 搭建自己的 Git 服务器](https://blog.mynook.info/post/host-your-own-git-server-using-gogs/) (Chinese) +- [阿里云上 Ubuntu 14.04 64 位安装 Gogs](http://my.oschina.net/luyao/blog/375654) (Chinese) +- [Installing Gogs on FreeBSD](https://www.codejam.info/2015/03/installing-gogs-on-freebsd.html) +- [Cloudflare Full SSL with Gogs using NGINX](http://www.listekconsulting.com/articles/cloudflare-full-ssl-with-gogs-go-git-service-using-nginx/) +- [How to install Gogs on a Linux Server (DigitalOcean)](https://www.youtube.com/watch?v=deSfX0gqefE) + +## Software, service and product support -- [Drone](https://github.com/drone/drone) (CI) -- [Jenkins](https://wiki.jenkins-ci.org/display/JENKINS/Gogs+Webhook+Plugin) (CI) - [Fabric8](http://fabric8.io/) (DevOps) +- [Jenkins](https://plugins.jenkins.io/gogs-webhook/) (CI) - [Taiga](https://taiga.io/) (Project Management) -- [Puppet](https://forge.puppetlabs.com/Siteminds/gogs) (IT) -- [Kanboard](http://kanboard.net/plugin/gogs-webhook) (Project Management) +- [Puppet](https://forge.puppet.com/Siteminds/gogs) (IT) +- [Kanboard](https://github.com/kanboard/plugin-gogs-webhook) (Project Management) - [BearyChat](https://bearychat.com/) (Team Communication) -- [HiWork](http://www.hiwork.cc/) (Team Communication) - [GitPitch](https://gitpitch.com/) (Markdown Presentations) - -### Product Support - - [Synology](https://www.synology.com) (Docker) - [Syncloud](https://syncloud.org/) (App Store) diff --git a/README_ZH.md b/README_ZH.md index 0cb0dc663..e65f9d9fa 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -6,12 +6,13 @@ Gogs 是一款极易搭建的自助 Git 服务。 Gogs（`/gɑgz/`）项目旨在打造一个以最简便的方式搭建简单、稳定和可扩展的自助 Git 服务。使用 Go 语言开发使得 Gogs 能够通过独立的二进制分发，并且支持 Go 语言支持的 **所有平台**，包括 Linux、macOS、Windows 以及 ARM 平台。 -## 项目概览 +## 概览 -- 有关基本用法和变更日志，请通过 [使用手册](https://gogs.io/docs/intro) 查看。 -- 想要先睹为快？直接去 [在线体验](https://try.gogs.io/gogs/gogs) 。 -- 使用过程中遇到问题？尝试从 [故障排查](https://gogs.io/docs/intro/troubleshooting.html) 页面或 [用户论坛](https://discuss.gogs.io/) 获取帮助。 -- 希望帮助多国语言界面的翻译吗？请立即访问 [详情页面](https://gogs.io/docs/features/i18n.html)！ +- 请移步[官网](https://gogs.io)查看用户使用文档 +- 请通过 [CHANGELOG.md](CHANGELOG.md) 文件查看各个版本的变更历史 +- 想要先睹为快？直接去[在线体验](https://try.gogs.io/gogs/gogs)吧！ +- 使用过程中遇到问题？尝试[故障排查](https://gogs.io/docs/intro/troubleshooting.html)或者前往[用户论坛](https://discuss.gogs.io/)获取帮助 +- 希望帮助多国语言的翻译吗？请查看[本地化文档](https://gogs.io/docs/features/i18n.html) ## 主要特性 @@ -54,11 +55,6 @@ Gogs（`/gɑgz/`）项目旨在打造一个以最简便的方式搭建简单、 - [通过 Vagrant 安装](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs) - [通过基于 Kubernetes 的 Helm Charts](https://github.com/helm/charts/tree/master/incubator/gogs) -### 使用教程 - -- [使用 Gogs 搭建自己的 Git 服务器](https://blog.mynook.info/post/host-your-own-git-server-using-gogs/) -- [阿里云上 Ubuntu 14.04 64 位安装 Gogs](http://my.oschina.net/luyao/blog/375654) - ### 云端部署 - [OpenShift](https://github.com/tkisme/gogs-openshift) @@ -70,20 +66,20 @@ Gogs（`/gɑgz/`）项目旨在打造一个以最简便的方式搭建简单、 - [DPlatform](https://github.com/j8r/DPlatform) - [LunaNode](https://github.com/LunaNode/launchgogs) -## 软件及服务支持 +### 使用教程 + +- [使用 Gogs 搭建自己的 Git 服务器](https://blog.mynook.info/post/host-your-own-git-server-using-gogs/) +- [阿里云上 Ubuntu 14.04 64 位安装 Gogs](http://my.oschina.net/luyao/blog/375654) + +## 软件、服务以及产品支持 -- [Drone](https://github.com/drone/drone)（CI） -- [Jenkins](https://wiki.jenkins-ci.org/display/JENKINS/Gogs+Webhook+Plugin)（CI） - [Fabric8](http://fabric8.io/)（DevOps） +- [Jenkins](https://plugins.jenkins.io/gogs-webhook/)（CI） - [Taiga](https://taiga.io/)（项目管理） -- [Puppet](https://forge.puppetlabs.com/Siteminds/gogs)（IT） -- [Kanboard](http://kanboard.net/plugin/gogs-webhook)（项目管理） +- [Puppet](https://forge.puppet.com/Siteminds/gogs)（IT） +- [Kanboard](https://github.com/kanboard/plugin-gogs-webhook)（项目管理） - [BearyChat](https://bearychat.com/)（团队交流） -- [HiWork](http://www.hiwork.cc/)（团队交流） - [GitPitch](https://gitpitch.com/)（Markdown 演示） - -### 产品支持 - - [Synology](https://www.synology.com)（Docker） - [Syncloud](https://syncloud.org/)（应用商店）