blob: a557fe9b4c87de44785a0fd1f94a5f5769e1e356 [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,
Rob Pike624f9da2013-11-20 13:47:37 -08004visit http://golang.org/ or load doc/install-source.html
5in your web browser.
Russ Coxd27fa942009-11-08 09:57:37 -08006
7After installing Go, you can view a nicely formatted
Rob Pike624f9da2013-11-20 13:47:37 -08008doc/install-source.html by running godoc --http=:6060
9and then visiting http://localhost:6060/doc/install/source.
Russ Coxd27fa942009-11-08 09:57:37 -080010
11Unless otherwise noted, the Go source files are distributed
12under the BSD-style license found in the LICENSE file.
Andrew Gerrand3402c5e2010-07-30 14:00:59 +100013
14--
15
16Binary Distribution Notes
17
Russ Cox86920ad2010-08-24 20:00:50 -040018If you have just untarred a binary Go distribution, you need to set
19the environment variable $GOROOT to the full path of the go
20directory (the one containing this README). You can omit the
21variable if you unpack it into /usr/local/go, or if you rebuild
22from sources by running all.bash (see doc/install.html).
23You should also add the Go binary directory $GOROOT/bin
24to your shell's path.
Andrew Gerrand3402c5e2010-07-30 14:00:59 +100025
Russ Cox86920ad2010-08-24 20:00:50 -040026For example, if you extracted the tar file into $HOME/go, you might
27put the following in your .profile:
Andrew Gerrand3402c5e2010-07-30 14:00:59 +100028
Russ Cox86920ad2010-08-24 20:00:50 -040029 export GOROOT=$HOME/go
30 export PATH=$PATH:$GOROOT/bin
Andrew Gerrand3402c5e2010-07-30 14:00:59 +100031
Russ Cox86920ad2010-08-24 20:00:50 -040032See doc/install.html for more details.