blob: 8bf9e7b8cf6069429f9ff823155392dbbf9bb9b2 [file] [log] [blame]
Russ Coxd27fa942009-11-08 09:57:37 -08001This is the source code repository for the Go programming language.
2
3For documentation about how to install and use Go,
4visit http://golang.org/ or load doc/install.html in your web browser.
5
6After installing Go, you can view a nicely formatted
7doc/install.html by running godoc --http=:6060
8and then visiting http://localhost:6060/doc/install.html.
9
10Unless otherwise noted, the Go source files are distributed
11under the BSD-style license found in the LICENSE file.
Andrew Gerrand3402c5e2010-07-30 14:00:59 +100012
13--
14
15Binary Distribution Notes
16
Russ Cox86920ad2010-08-24 20:00:50 -040017If you have just untarred a binary Go distribution, you need to set
18the environment variable $GOROOT to the full path of the go
19directory (the one containing this README). You can omit the
20variable if you unpack it into /usr/local/go, or if you rebuild
21from sources by running all.bash (see doc/install.html).
22You should also add the Go binary directory $GOROOT/bin
23to your shell's path.
Andrew Gerrand3402c5e2010-07-30 14:00:59 +100024
Russ Cox86920ad2010-08-24 20:00:50 -040025For example, if you extracted the tar file into $HOME/go, you might
26put the following in your .profile:
Andrew Gerrand3402c5e2010-07-30 14:00:59 +100027
Russ Cox86920ad2010-08-24 20:00:50 -040028 export GOROOT=$HOME/go
29 export PATH=$PATH:$GOROOT/bin
Andrew Gerrand3402c5e2010-07-30 14:00:59 +100030
Russ Cox86920ad2010-08-24 20:00:50 -040031See doc/install.html for more details.