/gobyexample

Permalink
gobyexample/README.md
Newer
Older
Raw Normal view History
100644 60 lines (38 sloc) 1.69 KB
da067aa @mmcgrana readme
authored Oct 9, 2012
1 ## Go by Example
19b98e7 @mmcgrana notes
authored Sep 21, 2012
2
1a871c9 @mmcgrana Suppose a static system
authored Jan 3, 2016
3 Content and build toolchain for [Go by Example](https://gobyexample.com),
d3d265b @mmcgrana Fix typo in README
authored Jan 6, 2016
4 a site that teaches Go via annotated example programs.
44d4ed6 @mmcgrana fuck yeah books
authored Oct 1, 2012
5
cc6cf63 @mmcgrana formward looking readme
authored Oct 9, 2012
6
c38a8df @mmcgrana more readme
authored Oct 9, 2012
7 ### Overview
cc6cf63 @mmcgrana formward looking readme
authored Oct 9, 2012
8
1a871c9 @mmcgrana Suppose a static system
authored Jan 3, 2016
9 The Go by Example site is built by extracting code and
0c1a735 @mmcgrana tighten
authored Oct 10, 2012
10 comments from source files in `examples` and rendering
1a871c9 @mmcgrana Suppose a static system
authored Jan 3, 2016
11 them via the `templates` into a static `public`
12 directory. The programs implementing this build process
13 are in `tools`, along with some vendor'd dependencies
14 in `vendor`.
c38a8df @mmcgrana more readme
authored Oct 9, 2012
15
1a871c9 @mmcgrana Suppose a static system
authored Jan 3, 2016
16 The built `public` directory can be served by any
17 static content system. The production site uses S3 and
18 CloudFront, for example.
c38a8df @mmcgrana more readme
authored Oct 9, 2012
19
20
0c1a735 @mmcgrana tighten
authored Oct 10, 2012
21 ### Building
07f8742 @mmcgrana link up server
authored Oct 9, 2012
22
4d13040 @mmcgrana Be more explicit about setup
authored May 23, 2015
23 To build the site you'll need Go and Python installed. Run:
01e071b @mmcgrana cc license
authored Oct 9, 2012
24
44d4ed6 @mmcgrana fuck yeah books
authored Oct 1, 2012
25 ```console
780888b @mmcgrana Add explicit go get for blackfriday lib, closes #64
authored Jan 16, 2014
26 $ go get github.com/russross/blackfriday
f313b49 @adamjgray Updated build instructions to use tools/ instead of tool/
adamjgray authored Oct 11, 2012
27 $ tools/build
72b2276 @mmcgrana first pass at import
authored Nov 17, 2012
28 $ open public/index.html
c4f1cb5 @mmcgrana fix highlighting
authored Oct 1, 2012
29 ```
01e071b @mmcgrana cc license
authored Oct 9, 2012
30
bdadb40 @mmcgrana tool/build-loop
authored Oct 9, 2012
31 To build continuously in a loop:
32
33 ```console
f313b49 @adamjgray Updated build instructions to use tools/ instead of tool/
adamjgray authored Oct 11, 2012
34 $ tools/build-loop
bdadb40 @mmcgrana tool/build-loop
authored Oct 9, 2012
35 ```
36
da067aa @mmcgrana readme
authored Oct 9, 2012
37
01e071b @mmcgrana cc license
authored Oct 9, 2012
38 ### License
39
96e55fd @mmcgrana use the gopher logo
authored Oct 6, 2013
40 This work is copyright Mark McGranaghan and licensed under a
41 [Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/).
42
572d7e3 @jaywgraves Fix Gopher icon attribution
jaywgraves authored Mar 25, 2014
43 The Go Gopher is copyright [Renée French](http://reneefrench.blogspot.com/) and licensed under a
0c1a735 @mmcgrana tighten
authored Oct 10, 2012
44 [Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/).
b13edb8 @mmcgrana thanks
authored Oct 10, 2012
45
46
370a81f @mmcgrana Add Translations index to Readme, ref #74
authored May 3, 2014
47 ### Translations
48
49 Contributor translations of the Go by Example site are available in:
50
2a88bcc @jjchern Update README.md
jjchern authored May 25, 2015
51 * [Chinese](http://gobyexample.everyx.in/) by [everyx](https://github.com/everyx)
d9e992f @mmcgrana Normalize translation link style
authored Jul 16, 2015
52 * [Spanish](http://goconejemplos.com) by the [Go Mexico community](https://github.com/dabit/gobyexample)
6bf518a @cortinico Added Italian translation in README
cortinico authored May 7, 2016
53 * [Italian](http://gobyexample.it) by the [Golang Italian community](https://github.com/golangit/gobyexample-it)
370a81f @mmcgrana Add Translations index to Readme, ref #74
authored May 3, 2014
54
b13edb8 @mmcgrana thanks
authored Oct 10, 2012
55 ### Thanks
56
57 Thanks to [Jeremy Ashkenas](https://github.com/jashkenas)
58 for [Docco](http://jashkenas.github.com/docco/), which
59 inspired this project.