blob: 4e6d7bde1fae42cc830c7f1760abcb7a12d839a8 [file] [log] [blame] [view]
Andrew Gerrand495e02d2014-12-10 16:06:47 +11001# The Go Programming Language
2
Andrew Gerrand69f24cf2014-12-11 09:44:54 +11003Go is an open source programming language that makes it easy to build simple,
4reliable, and efficient software.
5
Andrew Gerrand495e02d2014-12-10 16:06:47 +11006![Gopher image](doc/gopher/fiveyears.jpg)
7
8For documentation about how to install and use Go,
Andrew Gerrand69f24cf2014-12-11 09:44:54 +11009visit https://golang.org/ or load doc/install-source.html
Andrew Gerrand495e02d2014-12-10 16:06:47 +110010in your web browser.
11
12Our canonical Git repository is located at https://go.googlesource.com/go.
Ryan Seysac452342015-02-18 21:34:44 -050013There is a mirror of the repository at https://github.com/golang/go.
Andrew Gerrand495e02d2014-12-10 16:06:47 +110014
Andrew Gerrand69f24cf2014-12-11 09:44:54 +110015Please report issues here: https://golang.org/issue/new
Andrew Gerrand495e02d2014-12-10 16:06:47 +110016
17Go is the work of hundreds of contributors. We appreciate your help!
18
19To contribute, please read the contribution guidelines:
Andrew Gerrand69f24cf2014-12-11 09:44:54 +110020 https://golang.org/doc/contribute.html
Andrew Gerrand495e02d2014-12-10 16:06:47 +110021
Robert Griesemerf21ee1e2015-01-08 10:35:44 -080022##### Please note that we do not use pull requests.
23
Andrew Gerrand495e02d2014-12-10 16:06:47 +110024Unless otherwise noted, the Go source files are distributed
25under the BSD-style license found in the LICENSE file.
26
27--
28
29## Binary Distribution Notes
30
31If you have just untarred a binary Go distribution, you need to set
32the environment variable $GOROOT to the full path of the go
Andrew Gerrand69f24cf2014-12-11 09:44:54 +110033directory (the one containing this file). You can omit the
Andrew Gerrand495e02d2014-12-10 16:06:47 +110034variable if you unpack it into /usr/local/go, or if you rebuild
Andrew Gerrand69f24cf2014-12-11 09:44:54 +110035from sources by running all.bash (see doc/install-source.html).
Andrew Gerrand495e02d2014-12-10 16:06:47 +110036You should also add the Go binary directory $GOROOT/bin
37to your shell's path.
38
39For example, if you extracted the tar file into $HOME/go, you might
40put the following in your .profile:
41
42 export GOROOT=$HOME/go
43 export PATH=$PATH:$GOROOT/bin
44
45See https://golang.org/doc/install or doc/install.html for more details.