From: Andrew Gerrand Date: Wed, 10 Dec 2014 22:44:54 +0000 (+1100) Subject: doc: update README.md and CONTRIBUTING.md in response to review comments X-Git-Tag: go1.5beta1~2656 X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=69f24cfa14ba982e0118e240021f0e91f8efe937;p=gostls13.git doc: update README.md and CONTRIBUTING.md in response to review comments I didn't 'add' these files before my final mail. Change-Id: Id6f25629638e58421a3dee7632aec38aad9b1970 Reviewed-on: https://go-review.googlesource.com/1340 Reviewed-by: Andrew Gerrand --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f6dc311153..6444e76b5c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,6 @@ before sending patches. **We do not accept GitHub pull requests** (we use [Gerrit](https://code.google.com/p/gerrit/) instead for code review). -Unless otherwise noted, the Go source files ared istributed under +Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file. diff --git a/README.md b/README.md index 478021e151..53d42c5b52 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,23 @@ # The Go Programming Language +Go is an open source programming language that makes it easy to build simple, +reliable, and efficient software. + ![Gopher image](doc/gopher/fiveyears.jpg) For documentation about how to install and use Go, -visit http://golang.org/ or load doc/install-source.html +visit https://golang.org/ or load doc/install-source.html in your web browser. Our canonical Git repository is located at https://go.googlesource.com/go. (There is a mirror of the repository at https://github.com/golang/go.) -Please report issues here: https://github.com/golang/go/issues +Please report issues here: https://golang.org/issue/new Go is the work of hundreds of contributors. We appreciate your help! To contribute, please read the contribution guidelines: - http://golang.org/doc/contribute.html + https://golang.org/doc/contribute.html Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file. @@ -25,9 +28,9 @@ under the BSD-style license found in the LICENSE file. If you have just untarred a binary Go distribution, you need to set the environment variable $GOROOT to the full path of the go -directory (the one containing this README). You can omit the +directory (the one containing this file). You can omit the variable if you unpack it into /usr/local/go, or if you rebuild -from sources by running all.bash (see doc/install.html). +from sources by running all.bash (see doc/install-source.html). You should also add the Go binary directory $GOROOT/bin to your shell's path.