Home | History | Annotate | Download | only in doc
      1 <!--{
      2 	"Title": "Documentation",
      3 	"Path": "/doc/"
      4 }-->
      5 
      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>
     22 
     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 
     32 <h2 id="learning">Learning Go</h2>
     33 
     34 <img class="gopher" src="/doc/gopher/doc.png"/>
     35 
     36 <h3 id="go_tour"><a href="//tour.golang.org/">A Tour of Go</a></h3>
     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
     42 learned. You can <a href="//tour.golang.org/">take the tour online</a> or
     43 install it locally with:
     44 </p>
     45 <p>
     46 <pre>
     47 $ go get golang.org/x/tour/gotour
     48 </pre>
     49 This will place the <code>gotour</code> binary in your workspace's <code>bin</code> directory.
     50 </p>
     51 
     52 <h3 id="code"><a href="code.html">How to write Go code</a></h3>
     53 <p>
     54 Also available as a
     55 <a href="//www.youtube.com/watch?v=XCsL89YtqCs">screencast</a>, this doc
     56 explains how to use the <a href="/cmd/go/">go command</a> to fetch, build, and
     57 install packages, commands, and run tests.
     58 </p>
     59 
     60 <h3 id="effective_go"><a href="effective_go.html">Effective Go</a></h3>
     61 <p>
     62 A document that gives tips for writing clear, idiomatic Go code.
     63 A must read for any new Go programmer. It augments the tour and
     64 the language specification, both of which should be read first.
     65 </p>
     66 
     67 <h3 id="faq"><a href="/doc/faq">Frequently Asked Questions (FAQ)</a></h3>
     68 <p>
     69 Answers to common questions about Go.
     70 </p>
     71 
     72 <h3 id="wiki"><a href="/wiki">The Go Wiki</a></h3>
     73 <p>A wiki maintained by the Go community.</p>
     74 
     75 <h4 id="learn_more">More</h4>
     76 <p>
     77 See the <a href="/wiki/Learn">Learn</a> page at the <a href="/wiki">Wiki</a>
     78 for more Go learning resources.
     79 </p>
     80 
     81 
     82 <h2 id="references">References</h2>
     83 
     84 <h3 id="pkg"><a href="/pkg/">Package Documentation</a></h3>
     85 <p>
     86 The documentation for the Go standard library.
     87 </p>
     88 
     89 <h3 id="cmd"><a href="/doc/cmd">Command Documentation</a></h3>
     90 <p>
     91 The documentation for the Go tools.
     92 </p>
     93 
     94 <h3 id="spec"><a href="/ref/spec">Language Specification</a></h3>
     95 <p>
     96 The official Go Language specification.
     97 </p>
     98 
     99 <h3 id="go_mem"><a href="/ref/mem">The Go Memory Model</a></h3>
    100 <p>
    101 A document that specifies the conditions under which reads of a variable in
    102 one goroutine can be guaranteed to observe values produced by writes to the
    103 same variable in a different goroutine.
    104 </p>
    105 
    106 <h3 id="release"><a href="/doc/devel/release.html">Release History</a></h3>
    107 <p>A summary of the changes between Go releases.</p>
    108 
    109 
    110 <h2 id="articles">Articles</h2>
    111 
    112 <h3 id="blog"><a href="//blog.golang.org/">The Go Blog</a></h3>
    113 <p>The official blog of the Go project, featuring news and in-depth articles by
    114 the Go team and guests.</p>
    115 
    116 <h4>Codewalks</h4>
    117 <p>
    118 Guided tours of Go programs.
    119 </p>
    120 <ul>
    121 <li><a href="/doc/codewalk/functions">First-Class Functions in Go</a></li>
    122 <li><a href="/doc/codewalk/markov">Generating arbitrary text: a Markov chain algorithm</a></li>
    123 <li><a href="/doc/codewalk/sharemem">Share Memory by Communicating</a></li>
    124 <li><a href="/doc/articles/wiki/">Writing Web Applications</a> - building a simple web application.</li>
    125 </ul>
    126 
    127 <h4>Language</h4>
    128 <ul>
    129 <li><a href="/blog/json-rpc-tale-of-interfaces">JSON-RPC: a tale of interfaces</a></li>
    130 <li><a href="/blog/gos-declaration-syntax">Go's Declaration Syntax</a></li>
    131 <li><a href="/blog/defer-panic-and-recover">Defer, Panic, and Recover</a></li>
    132 <li><a href="/blog/go-concurrency-patterns-timing-out-and">Go Concurrency Patterns: Timing out, moving on</a></li>
    133 <li><a href="/blog/go-slices-usage-and-internals">Go Slices: usage and internals</a></li>
    134 <li><a href="/blog/gif-decoder-exercise-in-go-interfaces">A GIF decoder: an exercise in Go interfaces</a></li>
    135 <li><a href="/blog/error-handling-and-go">Error Handling and Go</a></li>
    136 <li><a href="/blog/organizing-go-code">Organizing Go code</a></li>
    137 </ul>
    138 
    139 <h4>Packages</h4>
    140 <ul>
    141 <li><a href="/blog/json-and-go">JSON and Go</a> - using the <a href="/pkg/encoding/json/">json</a> package.</li>
    142 <li><a href="/blog/gobs-of-data">Gobs of data</a> - the design and use of the <a href="/pkg/encoding/gob/">gob</a> package.</li>
    143 <li><a href="/blog/laws-of-reflection">The Laws of Reflection</a> - the fundamentals of the <a href="/pkg/reflect/">reflect</a> package.</li>
    144 <li><a href="/blog/go-image-package">The Go image package</a> - the fundamentals of the <a href="/pkg/image/">image</a> package.</li>
    145 <li><a href="/blog/go-imagedraw-package">The Go image/draw package</a> - the fundamentals of the <a href="/pkg/image/draw/">image/draw</a> package.</li>
    146 </ul>
    147 
    148 <h4>Tools</h4>
    149 <ul>
    150 <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>
    151 <li><a href="/blog/c-go-cgo">C? Go? Cgo!</a> - linking against C code with <a href="/cmd/cgo/">cgo</a>.</li>
    152 <li><a href="/doc/gdb">Debugging Go Code with GDB</a></li>
    153 <li><a href="/blog/godoc-documenting-go-code">Godoc: documenting Go code</a> - writing good documentation for <a href="/cmd/godoc/">godoc</a>.</li>
    154 <li><a href="/blog/profiling-go-programs">Profiling Go Programs</a></li>
    155 <li><a href="/doc/articles/race_detector.html">Data Race Detector</a> - a manual for the data race detector.</li>
    156 <li><a href="/blog/race-detector">Introducing the Go Race Detector</a> - an introduction to the race detector.</li>
    157 <li><a href="/doc/asm">A Quick Guide to Go's Assembler</a> - an introduction to the assembler used by Go.</li>
    158 </ul>
    159 
    160 <h4 id="articles_more">More</h4>
    161 <p>
    162 See the <a href="/wiki/Articles">Articles page</a> at the
    163 <a href="/wiki">Wiki</a> for more Go articles.
    164 </p>
    165 
    166 
    167 <h2 id="talks">Talks</h2>
    168 
    169 <img class="gopher" src="/doc/gopher/talks.png"/>
    170 
    171 <h3 id="video_tour_of_go"><a href="http://research.swtch.com/gotour">A Video Tour of Go</a></h3>
    172 <p>
    173 Three things that make Go fast, fun, and productive:
    174 interfaces, reflection, and concurrency. Builds a toy web crawler to
    175 demonstrate these.
    176 </p>
    177 
    178 <h3 id="go_code_that_grows"><a href="//vimeo.com/53221560">Code that grows with grace</a></h3>
    179 <p>
    180 One of Go's key design goals is code adaptability; that it should be easy to take a simple design and build upon it in a clean and natural way. In this talk Andrew Gerrand describes a simple "chat roulette" server that matches pairs of incoming TCP connections, and then use Go's concurrency mechanisms, interfaces, and standard library to extend it with a web interface and other features. While the function of the program changes dramatically, Go's flexibility preserves the original design as it grows.
    181 </p>
    182 
    183 <h3 id="go_concurrency_patterns"><a href="//www.youtube.com/watch?v=f6kdp27TYZs">Go Concurrency Patterns</a></h3>
    184 <p>
    185 Concurrency is the key to designing high performance network services. Go's concurrency primitives (goroutines and channels) provide a simple and efficient means of expressing concurrent execution. In this talk we see how tricky concurrency problems can be solved gracefully with simple Go code.
    186 </p>
    187 
    188 <h3 id="advanced_go_concurrency_patterns"><a href="//www.youtube.com/watch?v=QDDwwePbDtw">Advanced Go Concurrency Patterns</a></h3>
    189 <p>
    190 This talk expands on the <i>Go Concurrency Patterns</i> talk to dive deeper into Go's concurrency primitives.
    191 </p>
    192 
    193 <h4 id="talks_more">More</h4>
    194 <p>
    195 See the <a href="/talks">Go Talks site</a> and <a href="/wiki/GoTalks">wiki page</a> for more Go talks.
    196 </p>
    197 
    198 
    199 <h2 id="nonenglish">Non-English Documentation</h2>
    200 
    201 <p>
    202 See the <a href="/wiki/NonEnglish">NonEnglish</a> page
    203 at the <a href="/wiki">Wiki</a> for localized
    204 documentation.
    205 </p>
    206