cybercyst/go
1
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-05-05 15:43:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: convert README to markdown and update CONTRIBUTING.md

Browse Source 
Fixes #9233

Change-Id: If64480cbfaafe44025fcdcc0f20d76c995ffb3a1
Reviewed-on: https://go-review.googlesource.com/1296
Reviewed-by: Russ Cox <rsc@golang.org>
This commit is contained in:
Andrew Gerrand 2014-12-10 16:06:47 +11:00
parent bee8ae1185
commit 495e02db8c
2 changed files with 40 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
CONTRIBUTING.md
View File

@ -1,15 +1,29 @@
The Go project is an open source project. # Contributing to Go
For information, see: https://golang.org/
Its canonical Git repository is located at https://go.googlesource.com/go. Go is an open source project.
(There is a mirror of the repository at https://github.com/golang/go.)
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: ## Filing issues
http://golang.org/doc/contribute.html
## 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.

25
README → README.md
View File

@ -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, For documentation about how to install and use Go,
visit http://golang.org/ or load doc/install-source.html visit http://golang.org/ or load doc/install-source.html
in your web browser. in your web browser.
After installing Go, you can view a nicely formatted Our canonical Git repository is located at https://go.googlesource.com/go.
doc/install-source.html by running godoc --http=:6060 (There is a mirror of the repository at https://github.com/golang/go.)
and then visiting http://localhost:6060/doc/install/source.
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 Unless otherwise noted, the Go source files are distributed
under the BSD-style license found in the LICENSE file. 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 If you have just untarred a binary Go distribution, you need to set
the environment variable $GOROOT to the full path of the go 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 For example, if you extracted the tar file into $HOME/go, you might
put the following in your .profile: put the following in your .profile:
export GOROOT=$HOME/go export GOROOT=$HOME/go
export PATH=$PATH:$GOROOT/bin 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.