doc: convert README to markdown and update CONTRIBUTING.md

Fixes #9233

Change-Id: If64480cbfaafe44025fcdcc0f20d76c995ffb3a1
Reviewed-on: https://go-review.googlesource.com/1296
Reviewed-by: Russ Cox <rsc@golang.org>

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 736de379bc5adb850d67fb694cb3419f2500bc38..f6dc31115367d64329772de26b33a7b2e034a54c 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,15 +1,29 @@
-The Go project is an open source project.
-For information, see: https://golang.org/
+# Contributing to Go
 
-Its canonical Git repository is located at https://go.googlesource.com/go.
-(There is a mirror of the repository at https://github.com/golang/go.)
+Go is an open source project.
 
-Report issues here: https://github.com/golang/go/issues
+It is the work of hundreds of contributors. We appreciate your help!
 
-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
+## Filing issues
 
-## We DO NOT accept pull requests.
+When filing an issue, make sure to answer these five questions:
+
+1. What version of Go are you using (`go version`)?
+2. What operating system and processor architecture are you using?
+3. What did you do?
+4. What did you expect to see?
+5. What did you see instead?
+
+
+## Contributing code
+
+Please read the [Contribution Guidelines](https://golang.org/doc/contribute.html)
+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
+the BSD-style license found in the LICENSE file.
 

diff --git a/README b/README.md
similarity index 55%
rename from README
rename to README.md
index a557fe9b4c87de44785a0fd1f94a5f5769e1e356..478021e151239c34d8750ff11cfde8432735585e 100644 (file)
--- a/README
+++ b/README.md
@@ -1,19 +1,27 @@
-This is the source code repository for the Go programming language.  
+# The Go Programming Language
+
+![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
 in your web browser.
 
-After installing Go, you can view a nicely formatted
-doc/install-source.html by running godoc --http=:6060
-and then visiting http://localhost:6060/doc/install/source.
+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
+
+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
 
 Unless otherwise noted, the Go source files are distributed
 under the BSD-style license found in the LICENSE file.
 
 --
 
-Binary Distribution Notes
+## Binary Distribution Notes
 
 If you have just untarred a binary Go distribution, you need to set
 the environment variable $GOROOT to the full path of the go
@@ -26,7 +34,8 @@ to your shell's path.
 For example, if you extracted the tar file into $HOME/go, you might
 put the following in your .profile:
 
-    export GOROOT=$HOME/go
-    export PATH=$PATH:$GOROOT/bin
+       export GOROOT=$HOME/go
+       export PATH=$PATH:$GOROOT/bin
+
+See https://golang.org/doc/install or doc/install.html for more details.
 
-See doc/install.html for more details.