]> Cypherpunks.ru repositories - gostls13.git/blob - README.md
doc: update README.md and CONTRIBUTING.md in response to review comments
[gostls13.git] / README.md
1 # The Go Programming Language
2
3 Go is an open source programming language that makes it easy to build simple,
4 reliable, and efficient software.
5
6 ![Gopher image](doc/gopher/fiveyears.jpg)
7
8 For documentation about how to install and use Go,
9 visit https://golang.org/ or load doc/install-source.html
10 in your web browser.
11
12 Our canonical Git repository is located at https://go.googlesource.com/go.
13 (There is a mirror of the repository at https://github.com/golang/go.)
14
15 Please report issues here: https://golang.org/issue/new
16
17 Go is the work of hundreds of contributors. We appreciate your help!
18
19 To contribute, please read the contribution guidelines:
20         https://golang.org/doc/contribute.html
21
22 Unless otherwise noted, the Go source files are distributed
23 under the BSD-style license found in the LICENSE file.
24
25 --
26
27 ## Binary Distribution Notes
28
29 If you have just untarred a binary Go distribution, you need to set
30 the environment variable $GOROOT to the full path of the go
31 directory (the one containing this file).  You can omit the
32 variable if you unpack it into /usr/local/go, or if you rebuild
33 from sources by running all.bash (see doc/install-source.html).
34 You should also add the Go binary directory $GOROOT/bin
35 to your shell's path.
36
37 For example, if you extracted the tar file into $HOME/go, you might
38 put the following in your .profile:
39
40         export GOROOT=$HOME/go
41         export PATH=$PATH:$GOROOT/bin
42
43 See https://golang.org/doc/install or doc/install.html for more details.
44