Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xg-wang committed Nov 19, 2017
1 parent e4fe466 commit 57dc45f
Showing 1 changed file with 68 additions and 9 deletions.
77 changes: 68 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
## Go by Example 中文版

本翻译是 [mmcgrana](https://github.com/mmcgrana)[Go by Example](https://github.com/mmcgrana/gobyexample)中文翻译,除为 github page 做出的部分修改外,完全遵从原作的模式。现已经完成了所有文件的初步翻译,比较粗糙,其中纰漏也很多,欢迎 fork 并提交 pull request。
本项目是 [mmcgrana](https://github.com/mmcgrana)[Go by Example](https://github.com/mmcgrana/gobyexample)中文翻译。现已由[everyx](https://github.com/everyx)完成了所有文件的初步翻译,比较粗糙,其中纰漏也很多,目前正在准备第二版的翻译,欢迎 fork 并提交 pull request。

还等什么,[马上开始学习吧](https://gobyexample.xgwang.me)
### 贡献说明

### 说明

1. 首先在 `examples` 目录下找到对应的内容,完成修改。注:只需注意 `.go` 文件和 `.sh` 文件。`.hash` 文件是在使用 `tools/build` 后自动更新的,主要用于判断文件内容是否被修改;

2. 然后使用 `tools/build` 命令重新生成网页。这一步会格式化代码,并判断是否修改,修改的内容会重新提交示例代码至 `http://play.golang.org/`,并更新静态页;

3. 提交 pull request :)
1. 首先在· `examples` 目录下找到对应的内容,完成修改。注:只需注意 `.go` 文件和 `.sh` 文件。`.hash` 文件是在使用 `tools/build` 后自动更新的,主要用于判断文件内容是否被修改;
1. 然后使用 `tools/build` 命令重新生成网页。这一步会格式化代码,并判断是否修改,修改的内容会重新提交示例代码至 `http://play.golang.org/`,并更新静态页;
1. `tools/serve` 本地测试结果;
1. 提交 pull request :)

### License

Expand All @@ -28,3 +25,65 @@ The Go Gopher is copyright [Renée French](http://reneefrench.blogspot.com/) and
### 致谢

本翻译项目原作者[everyx](https://github.com/everyx),以及所有[贡献者](https://github.com/xg-wang/gobyexample/graphs/contributors)

---

## Go by Example 原版 README

Content and build toolchain for [Go by Example](https://gobyexample.com),
a site that teaches Go via annotated example programs.


### Overview

The Go by Example site is built by extracting code and
comments from source files in `examples` and rendering
them via the `templates` into a static `public`
directory. The programs implementing this build process
are in `tools`, along with some vendor'd dependencies
in `vendor`.

The built `public` directory can be served by any
static content system. The production site uses S3 and
CloudFront, for example.


### Building

To build the site you'll need Go and Python installed. Run:

```console
$ go get github.com/russross/blackfriday
$ tools/build
$ open public/index.html
```

To build continuously in a loop:

```console
$ tools/build-loop
```


### License

This work is copyright Mark McGranaghan and licensed under a
[Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/).

The Go Gopher is copyright [Renée French](http://reneefrench.blogspot.com/) and licensed under a
[Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/).


### Translations

Contributor translations of the Go by Example site are available in:

* [French](http://le-go-par-l-exemple.keiruaprod.fr) by [keirua](https://github.com/keirua/gobyexample)
* [Italian](http://gobyexample.it) by the [Go Italian community](https://github.com/golangit/gobyexample-it)
* [Spanish](http://goconejemplos.com) by the [Go Mexico community](https://github.com/dabit/gobyexample)

### Thanks

Thanks to [Jeremy Ashkenas](https://github.com/jashkenas)
for [Docco](http://jashkenas.github.com/docco/), which
inspired this project.

0 comments on commit 57dc45f

Please sign in to comment.