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