Andrew Gerrand | 495e02d | 2014-12-10 16:06:47 +1100 | [diff] [blame] | 1 | # The Go Programming Language |
| 2 | |
Andrew Gerrand | 69f24cf | 2014-12-11 09:44:54 +1100 | [diff] [blame] | 3 | Go is an open source programming language that makes it easy to build simple, |
| 4 | reliable, and efficient software. |
| 5 | |
Andrew Gerrand | 495e02d | 2014-12-10 16:06:47 +1100 | [diff] [blame] | 6 |  |
| 7 | |
| 8 | For documentation about how to install and use Go, |
Andrew Gerrand | 69f24cf | 2014-12-11 09:44:54 +1100 | [diff] [blame] | 9 | visit https://golang.org/ or load doc/install-source.html |
Andrew Gerrand | 495e02d | 2014-12-10 16:06:47 +1100 | [diff] [blame] | 10 | in your web browser. |
| 11 | |
| 12 | Our canonical Git repository is located at https://go.googlesource.com/go. |
Ryan Seys | ac45234 | 2015-02-18 21:34:44 -0500 | [diff] [blame] | 13 | There is a mirror of the repository at https://github.com/golang/go. |
Andrew Gerrand | 495e02d | 2014-12-10 16:06:47 +1100 | [diff] [blame] | 14 | |
Andrew Gerrand | 495e02d | 2014-12-10 16:06:47 +1100 | [diff] [blame] | 15 | Go is the work of hundreds of contributors. We appreciate your help! |
| 16 | |
| 17 | To contribute, please read the contribution guidelines: |
Andrew Gerrand | 69f24cf | 2014-12-11 09:44:54 +1100 | [diff] [blame] | 18 | https://golang.org/doc/contribute.html |
Andrew Gerrand | 495e02d | 2014-12-10 16:06:47 +1100 | [diff] [blame] | 19 | |
Robert Griesemer | 4c2a400 | 2015-10-02 10:55:27 -0700 | [diff] [blame] | 20 | ##### Note that we do not accept pull requests and that we use the issue tracker for bug reports and proposals only. Please ask questions on https://forum.golangbridge.org or https://groups.google.com/forum/#!forum/golang-nuts. |
Robert Griesemer | f21ee1e | 2015-01-08 10:35:44 -0800 | [diff] [blame] | 21 | |
Andrew Gerrand | 495e02d | 2014-12-10 16:06:47 +1100 | [diff] [blame] | 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 |
Andrew Gerrand | 69f24cf | 2014-12-11 09:44:54 +1100 | [diff] [blame] | 31 | directory (the one containing this file). You can omit the |
Andrew Gerrand | 495e02d | 2014-12-10 16:06:47 +1100 | [diff] [blame] | 32 | variable if you unpack it into /usr/local/go, or if you rebuild |
Andrew Gerrand | 69f24cf | 2014-12-11 09:44:54 +1100 | [diff] [blame] | 33 | from sources by running all.bash (see doc/install-source.html). |
Andrew Gerrand | 495e02d | 2014-12-10 16:06:47 +1100 | [diff] [blame] | 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. |