Andrew Gerrand | 7cb21a7 | 2012-01-19 11:24:54 +1100 | [diff] [blame] | 1 | <!--{ |
Andrew Gerrand | 8bbe5cc | 2012-01-20 07:37:36 +1100 | [diff] [blame] | 2 | "Title": "Documentation", |
| 3 | "Path": "/doc/" |
Andrew Gerrand | 7cb21a7 | 2012-01-19 11:24:54 +1100 | [diff] [blame] | 4 | }--> |
Andrew Gerrand | 1ca99c8 | 2010-05-27 16:47:42 -0700 | [diff] [blame] | 5 | |
Andrew Gerrand | d84de09 | 2012-02-13 21:22:36 +1100 | [diff] [blame] | 6 | <p> |
| 7 | The Go programming language is an open source project to make programmers more |
| 8 | productive. |
| 9 | </p> |
| 10 | |
| 11 | <p> |
| 12 | Go is expressive, concise, clean, and efficient. Its concurrency |
| 13 | mechanisms make it easy to write programs that get the most out of multicore |
| 14 | and networked machines, while its novel type system enables flexible and |
| 15 | modular program construction. Go compiles quickly to machine code yet has the |
| 16 | convenience of garbage collection and the power of run-time reflection. It's a |
| 17 | fast, statically typed, compiled language that feels like a dynamically typed, |
| 18 | interpreted language. |
| 19 | </p> |
| 20 | |
| 21 | <div id="manual-nav"></div> |
Andrew Gerrand | 6ab8d24 | 2010-09-16 14:01:02 +1000 | [diff] [blame] | 22 | |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 23 | <h2>Installing Go</h2> |
| 24 | |
| 25 | <h3><a href="/doc/install">Getting Started</a></h3> |
| 26 | <p> |
| 27 | Instructions for downloading and installing the Go compilers, tools, and |
| 28 | libraries. |
| 29 | </p> |
| 30 | |
| 31 | |
Andrew Gerrand | 6ab8d24 | 2010-09-16 14:01:02 +1000 | [diff] [blame] | 32 | <h2 id="learning">Learning Go</h2> |
| 33 | |
Andrew Gerrand | f200b72 | 2012-03-06 12:50:52 +1100 | [diff] [blame] | 34 | <img class="gopher" src="/doc/gopher/doc.png"/> |
| 35 | |
Andrew Gerrand | 1fe22d2 | 2011-11-01 16:09:29 +0900 | [diff] [blame] | 36 | <h3 id="go_tour"><a href="http://tour.golang.org/">A Tour of Go</a></h3> |
Andrew Gerrand | f03b37b | 2011-10-05 11:12:07 -0700 | [diff] [blame] | 37 | <p> |
| 38 | An interactive introduction to Go in three sections. |
| 39 | The first section covers basic syntax and data structures; the second discusses |
| 40 | methods and interfaces; and the third introduces Go's concurrency primitives. |
| 41 | Each section concludes with a few exercises so you can practice what you've |
Andrew Gerrand | 1fe22d2 | 2011-11-01 16:09:29 +0900 | [diff] [blame] | 42 | learned. You can <a href="http://tour.golang.org/">take the tour online</a> or |
Andrew Gerrand | f03b37b | 2011-10-05 11:12:07 -0700 | [diff] [blame] | 43 | <a href="http://code.google.com/p/go-tour/">install it locally</a>. |
| 44 | </p> |
| 45 | |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 46 | <h3 id="code"><a href="code.html">How to write Go code</a></h3> |
| 47 | <p> |
| 48 | How to use the <a href="/cmd/go/">go command</a> to fetch, build, and install |
| 49 | packages, commands, and run tests. |
| 50 | </p> |
| 51 | |
Andrew Gerrand | 1ca99c8 | 2010-05-27 16:47:42 -0700 | [diff] [blame] | 52 | <h3 id="effective_go"><a href="effective_go.html">Effective Go</a></h3> |
| 53 | <p> |
| 54 | A document that gives tips for writing clear, idiomatic Go code. |
Rob Pike | 7201b0c | 2012-02-28 13:35:58 +1100 | [diff] [blame] | 55 | A must read for any new Go programmer. It augments the tour and |
Peter Mundy | abb0c09 | 2010-11-29 10:10:02 +0900 | [diff] [blame] | 56 | the language specification, both of which should be read first. |
Andrew Gerrand | 1ca99c8 | 2010-05-27 16:47:42 -0700 | [diff] [blame] | 57 | </p> |
| 58 | |
Andrew Gerrand | dd91d83 | 2012-02-15 12:58:40 +1100 | [diff] [blame] | 59 | <h3 id="appengine"><a href="http://code.google.com/appengine/docs/go/gettingstarted/">Getting Started with Go on App Engine</a></h3> |
| 60 | <p> |
| 61 | How to develop and deploy a simple Go project with |
| 62 | <a href="http://code.google.com/appengine/">Google App Engine</a>. |
| 63 | </p> |
| 64 | |
Andrew Gerrand | d84de09 | 2012-02-13 21:22:36 +1100 | [diff] [blame] | 65 | <h3 id="go_faq"><a href="go_faq.html">Frequently Asked Questions (FAQ)</a></h3> |
Andrew Gerrand | 1ca99c8 | 2010-05-27 16:47:42 -0700 | [diff] [blame] | 66 | <p> |
Andrew Gerrand | d84de09 | 2012-02-13 21:22:36 +1100 | [diff] [blame] | 67 | Answers to common questions about Go. |
Andrew Gerrand | 1ca99c8 | 2010-05-27 16:47:42 -0700 | [diff] [blame] | 68 | </p> |
| 69 | |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 70 | <h3 id="wiki"><a href="http://code.google.com/p/go-wiki/wiki">Go Language Community Wiki</a></h3> |
Andrew Gerrand | 539178b | 2012-03-05 15:07:43 +1100 | [diff] [blame] | 71 | <p>A wiki maintained by the Go community.</p> |
Andrew Gerrand | d84de09 | 2012-02-13 21:22:36 +1100 | [diff] [blame] | 72 | |
Andrew Gerrand | c9836be | 2012-03-08 16:10:55 +1100 | [diff] [blame] | 73 | <h2 id="go1">Go version 1</h2> |
| 74 | |
| 75 | <h3 id="go1notes"><a href="/doc/go1.html">Go 1 Release Notes</a></h3> |
| 76 | <p> |
| 77 | A guide for updating your code to work with Go 1. |
| 78 | </p> |
| 79 | |
| 80 | <h3 id="go1compat"><a href="/doc/go1compat.html">Go 1 and the Future of Go Programs</a></h3> |
| 81 | <p> |
| 82 | What Go 1 defines and the backwards-compatibility guarantees one can expect as |
| 83 | Go 1 matures. |
| 84 | </p> |
| 85 | |
Andrew Gerrand | d84de09 | 2012-02-13 21:22:36 +1100 | [diff] [blame] | 86 | <h2 id="articles">Go Articles</h2> |
| 87 | |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 88 | <h3 id="blog"><a href="http://blog.golang.org/">The Go Blog</a></h3> |
| 89 | <p>The official blog of the Go project, featuring news and in-depth articles by |
| 90 | the Go team and guests.</p> |
| 91 | |
Andrew Gerrand | e8636a6 | 2012-03-13 11:00:11 +1100 | [diff] [blame] | 92 | <h4>Codewalks</h4> |
Yves Junqueira | de3a397 | 2010-11-23 10:43:16 +1100 | [diff] [blame] | 93 | <p> |
Francisco Souza | a786fe8 | 2012-03-27 13:35:40 +1100 | [diff] [blame^] | 94 | Guided tours of Go programs. |
Yves Junqueira | de3a397 | 2010-11-23 10:43:16 +1100 | [diff] [blame] | 95 | </p> |
Andrew Gerrand | 3bc2d0f | 2011-09-10 09:35:25 +1000 | [diff] [blame] | 96 | <ul> |
| 97 | <li><a href="/doc/codewalk/functions">First-Class Functions in Go</a></li> |
| 98 | <li><a href="/doc/codewalk/markov">Generating arbitrary text: a Markov chain algorithm</a></li> |
| 99 | <li><a href="/doc/codewalk/sharemem">Share Memory by Communicating</a></li> |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 100 | <li><a href="/doc/articles/wiki/">Writing Web Applications</a> - building a simple web application.</li> |
Andrew Gerrand | 3bc2d0f | 2011-09-10 09:35:25 +1000 | [diff] [blame] | 101 | </ul> |
Yves Junqueira | de3a397 | 2010-11-23 10:43:16 +1100 | [diff] [blame] | 102 | |
Andrew Gerrand | e8636a6 | 2012-03-13 11:00:11 +1100 | [diff] [blame] | 103 | <h4>Language</h4> |
Andrew Gerrand | 3bc2d0f | 2011-09-10 09:35:25 +1000 | [diff] [blame] | 104 | <ul> |
Francisco Souza | a786fe8 | 2012-03-27 13:35:40 +1100 | [diff] [blame^] | 105 | <li><a href="/doc/articles/json_rpc_tale_of_interfaces.html">JSON-RPC: a tale of interfaces</a></li> |
Francisco Souza | 6033a48 | 2012-03-13 14:46:08 +1100 | [diff] [blame] | 106 | <li><a href="/doc/articles/gos_declaration_syntax.html">Go's Declaration Syntax</a></li> |
Andrew Gerrand | 10689cd | 2012-02-21 13:59:51 +1100 | [diff] [blame] | 107 | <li><a href="/doc/articles/defer_panic_recover.html">Defer, Panic, and Recover</a></li> |
Rob Pike | a99e9c5 | 2012-03-23 07:51:16 +1100 | [diff] [blame] | 108 | <li><a href="/doc/articles/concurrency_patterns.html">Go Concurrency Patterns: Timing out, moving on</a></li> |
Andrew Gerrand | 10689cd | 2012-02-21 13:59:51 +1100 | [diff] [blame] | 109 | <li><a href="/doc/articles/slices_usage_and_internals.html">Go Slices: usage and internals</a></li> |
Andrew Gerrand | 3bc2d0f | 2011-09-10 09:35:25 +1000 | [diff] [blame] | 110 | <li><a href="http://blog.golang.org/2011/05/gif-decoder-exercise-in-go-interfaces.html">A GIF decoder: an exercise in Go interfaces</a></li> |
Andrew Gerrand | 10689cd | 2012-02-21 13:59:51 +1100 | [diff] [blame] | 111 | <li><a href="/doc/articles/error_handling.html">Error Handling and Go</a></li> |
Andrew Gerrand | 3bc2d0f | 2011-09-10 09:35:25 +1000 | [diff] [blame] | 112 | </ul> |
| 113 | |
Andrew Gerrand | e8636a6 | 2012-03-13 11:00:11 +1100 | [diff] [blame] | 114 | <h4>Packages</h4> |
Andrew Gerrand | 3bc2d0f | 2011-09-10 09:35:25 +1000 | [diff] [blame] | 115 | <ul> |
Francisco Souza | 289a357 | 2012-03-22 18:25:40 +1100 | [diff] [blame] | 116 | <li><a href="/doc/articles/json_and_go.html">JSON and Go</a> - using the <a href="/pkg/encoding/json/">json</a> package.</li> |
Francisco Souza | 9e03dcb | 2012-03-16 08:21:13 +1100 | [diff] [blame] | 117 | <li><a href="/doc/articles/gobs_of_data.html">Gobs of data</a> - the design and use of the <a href="/pkg/encoding/gob/">gob</a> package.</li> |
Johan Euphrosine | 6652b0b | 2012-03-01 10:05:51 +1100 | [diff] [blame] | 118 | <li><a href="/doc/articles/laws_of_reflection.html">The Laws of Reflection</a> - the fundamentals of the <a href="/pkg/reflect/">reflect</a> package.</li> |
Andrew Gerrand | 76d82db | 2011-09-23 07:22:28 +1000 | [diff] [blame] | 119 | <li><a href="http://blog.golang.org/2011/09/go-image-package.html">The Go image package</a> - the fundamentals of the <a href="/pkg/image/">image</a> package.</li> |
Johan Euphrosine | fef92cb | 2012-03-14 11:27:41 +1100 | [diff] [blame] | 120 | <li><a href="/doc/articles/image_draw.html">The Go image/draw package</a> - the fundamentals of the <a href="/pkg/image/draw/">image/draw</a> package.</li> |
Andrew Gerrand | 3bc2d0f | 2011-09-10 09:35:25 +1000 | [diff] [blame] | 121 | </ul> |
| 122 | |
Andrew Gerrand | e8636a6 | 2012-03-13 11:00:11 +1100 | [diff] [blame] | 123 | <h4>Tools</h4> |
Andrew Gerrand | 3bc2d0f | 2011-09-10 09:35:25 +1000 | [diff] [blame] | 124 | <ul> |
Andrew Gerrand | 73b8ccb | 2012-03-07 07:40:21 +1100 | [diff] [blame] | 125 | <li><a href="/doc/articles/go_command.html">About the Go command</a> - why we wrote it, what it is, what it's not, and how to use it.</li> |
Francisco Souza | 60b98d6 | 2012-03-13 09:07:37 +1100 | [diff] [blame] | 126 | <li><a href="/doc/articles/c_go_cgo.html">C? Go? Cgo!</a> - linking against C code with <a href="/cmd/cgo/">cgo</a>.</li> |
Andrew Gerrand | 98155bd | 2012-03-27 11:42:01 +1100 | [diff] [blame] | 127 | <li><a href="/doc/gdb">Debugging Go Code with GDB</a></li> |
Francisco Souza | 235863c | 2012-03-15 14:51:44 +1100 | [diff] [blame] | 128 | <li><a href="/doc/articles/godoc_documenting_go_code.html">Godoc: documenting Go code</a> - writing good documentation for <a href="/cmd/godoc/">godoc</a>.</li> |
Andrew Gerrand | 3bc2d0f | 2011-09-10 09:35:25 +1000 | [diff] [blame] | 129 | <li><a href="http://blog.golang.org/2011/06/profiling-go-programs.html">Profiling Go Programs</a></li> |
| 130 | </ul> |
| 131 | |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 132 | <h2 id="talks">Talks</h2> |
Andrew Gerrand | bab711b | 2010-07-30 10:36:13 +1000 | [diff] [blame] | 133 | |
Andrew Gerrand | f200b72 | 2012-03-06 12:50:52 +1100 | [diff] [blame] | 134 | <img class="gopher" src="/doc/gopher/talks.png"/> |
| 135 | |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 136 | <p> |
| 137 | The talks marked with a red asterisk (<font color="red">*</font>) were written |
| 138 | before Go 1 and contain some examples that are no longer correct, but they are |
| 139 | still of value. |
| 140 | </p> |
| 141 | |
| 142 | <h3 id="writing_web_apps"><a href="http://www.youtube.com/watch?v=-i0hat7pdpk">Writing Web Apps in Go</a><font color="red">*</font></h3> |
Andrew Gerrand | 4fb5857 | 2011-05-17 13:46:54 +1000 | [diff] [blame] | 143 | <p> |
| 144 | A talk by Rob Pike and Andrew Gerrand presented at Google I/O 2011. |
| 145 | It walks through the construction and deployment of a simple web application |
| 146 | and unveils the <a href="http://blog.golang.org/2011/05/go-and-google-app-engine.html">Go runtime for App Engine</a>. |
| 147 | See the <a href="/doc/talks/io2011/Writing_Web_Apps_in_Go.pdf">presentation slides</a>. |
| 148 | </p> |
| 149 | |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 150 | <h3 id="real_world_go"><a href="http://www.youtube.com/watch?v=7QDVRowyUQA">Real World Go</a><font color="red">*</font></h3> |
Andrew Gerrand | 4fb5857 | 2011-05-17 13:46:54 +1000 | [diff] [blame] | 151 | <p> |
| 152 | A talk by Andrew Gerrand presented at Google I/O Bootcamp 2011. |
| 153 | It gives a broad overview of Go's type system and concurrency model |
| 154 | and provides four examples of Go programs that solve real problems. |
| 155 | See the <a href="/doc/talks/io2011/Real_World_Go.pdf">presentation slides</a>. |
| 156 | </p> |
| 157 | |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 158 | <h3 id="integrated_apps"><a href="http://www.youtube.com/watch?v=Mo1YKpIF1PQ">Building Integrated Apps on Google's Cloud Platform</a></h3> |
| 159 | <p> |
| 160 | A talk by Andrew Gerrand presented at Google Developer Day Japan 2011. |
| 161 | It discusses the development of a web application that runs on Google |
| 162 | App Engine and renders images that it stores on Google Cloud Storage. |
| 163 | </p> |
| 164 | |
| 165 | <h3 id="go_programming"><a href="http://www.youtube.com/watch?v=jgVhBThJdXc">Go Programming</a><font color="red">*</font></h3> |
Andrew Gerrand | bab711b | 2010-07-30 10:36:13 +1000 | [diff] [blame] | 166 | <p> |
| 167 | A presentation delivered by Rob Pike and Russ Cox at Google I/O 2010. It |
| 168 | illustrates how programming in Go differs from other languages through a set of |
| 169 | examples demonstrating features particular to Go. These include concurrency, |
Francisco Souza | a786fe8 | 2012-03-27 13:35:40 +1100 | [diff] [blame^] | 170 | embedded types, methods on any type, and program construction using interfaces. |
Andrew Gerrand | bab711b | 2010-07-30 10:36:13 +1000 | [diff] [blame] | 171 | </p> |
Andrew Gerrand | 1ca99c8 | 2010-05-27 16:47:42 -0700 | [diff] [blame] | 172 | |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 173 | <h3 id="practical_go_programming"><a href="http://www.youtube.com/watch?v=2-pPAvqyluI">Practical Go Programming</a><font color="red">*</font></h3> |
Andrew Gerrand | 0e3eefa | 2010-12-03 06:57:30 +0900 | [diff] [blame] | 174 | <p> |
| 175 | This talk presents the development of a complete web application in Go. |
| 176 | It looks at design, storage, concurrency, and scaling issues in detail, using |
| 177 | the simple example of an URL shortening service. |
| 178 | See the <a href="http://wh3rd.net/practical-go/">presentation slides</a>. |
| 179 | </p> |
| 180 | |
Andrew Gerrand | e8636a6 | 2012-03-13 11:00:11 +1100 | [diff] [blame] | 181 | <h4 id="talks_more">More</h4> |
Andrew Gerrand | 1ca99c8 | 2010-05-27 16:47:42 -0700 | [diff] [blame] | 182 | <p> |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 183 | See the <a href="http://code.google.com/p/go-wiki/wiki/GoTalks">GoTalks |
| 184 | page</a> at the <a href="http://code.google.com/p/go-wiki/wiki">Go Wiki</a> for |
| 185 | more Go talks. |
Andrew Gerrand | 1ca99c8 | 2010-05-27 16:47:42 -0700 | [diff] [blame] | 186 | </p> |
| 187 | |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 188 | <h2 id="nonenglish">Non-English Documentation</h2> |
| 189 | |
Andrew Gerrand | 1748dc3 | 2010-10-14 17:25:23 +1100 | [diff] [blame] | 190 | <p> |
Francisco Souza | a786fe8 | 2012-03-27 13:35:40 +1100 | [diff] [blame^] | 191 | See the <a href="http://code.google.com/p/go-wiki/wiki/NonEnglish">NonEnglish</a> page |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 192 | at the <a href="http://code.google.com/p/go-wiki/wiki">Go Wiki</a> for localized |
| 193 | documentation. |
Andrew Gerrand | 1748dc3 | 2010-10-14 17:25:23 +1100 | [diff] [blame] | 194 | </p> |
| 195 | |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 196 | <h2 id="community">The Go Community</h2> |
Andrew Gerrand | 520d5db | 2010-07-02 13:32:02 +1000 | [diff] [blame] | 197 | |
Andrew Gerrand | f200b72 | 2012-03-06 12:50:52 +1100 | [diff] [blame] | 198 | <img class="gopher" src="/doc/gopher/project.png"/> |
| 199 | |
Andrew Gerrand | d84de09 | 2012-02-13 21:22:36 +1100 | [diff] [blame] | 200 | <h3 id="mailinglist"><a href="http://groups.google.com/group/golang-nuts">Go Nuts Mailing List</a></h3> |
Francisco Souza | a786fe8 | 2012-03-27 13:35:40 +1100 | [diff] [blame^] | 201 | <p>The <a href="http://groups.google.com/group/golang-nuts">golang-nuts</a> |
Andrew Gerrand | d84de09 | 2012-02-13 21:22:36 +1100 | [diff] [blame] | 202 | mailing list is for general Go discussion.</p> |
| 203 | |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 204 | <h3 id="projects"><a href="http://godashboard.appspot.com/project">Go Project Dashboard</a></h3> |
Andrew Gerrand | d84de09 | 2012-02-13 21:22:36 +1100 | [diff] [blame] | 205 | <p>A list of external Go projects including programs and libraries.</p> |
| 206 | |
| 207 | <h3 id="irc"><a href="irc:irc.freenode.net/go-nuts">Go IRC Channel</a></h3> |
| 208 | <p><b>#go-nuts</b> on <b>irc.freenode.net</b> is the official Go IRC channel.</p> |
| 209 | |
Andrew Gerrand | f78d50c | 2012-03-05 14:31:27 +1100 | [diff] [blame] | 210 | <h3 id="plus"><a href="https://plus.google.com/101406623878176903605/posts">The Go Programming Language at Google+</a></h3> |
| 211 | <p>The Go project's Google+ page.</p> |
| 212 | |
Andrew Gerrand | d84de09 | 2012-02-13 21:22:36 +1100 | [diff] [blame] | 213 | <h3 id="twitter"><a href="http://twitter.com/go_nuts">@go_nuts at Twitter</a></h3> |
| 214 | <p>The Go project's official Twitter account.</p> |