Skip to content
This repository was archived by the owner on Nov 5, 2024. It is now read-only.

Commit 68e087e

Browse files
committed
README: switch to Markdown and add links
Move the README to README.md so Gerrit can render it; currently Gerrit only renders files named exactly "README.md" (for example at https://go.googlesource.com/go). Add more links to the README explaining how to file issues, how to submit code changes, where to download the code to and how to get it. Hopefully this should help people who go to https://go.googlesource.com/tools or https://github.com/golang/tools figure out how to get started with development. Change-Id: I778202d9759df5cf79e86b8524046e108aa3db3d Reviewed-on: https://go-review.googlesource.com/49852 Reviewed-by: Brad Fitzpatrick <[email protected]>
1 parent e531a2a commit 68e087e

File tree

2 files changed

+27
-10
lines changed

2 files changed

+27
-10
lines changed

README

Lines changed: 0 additions & 10 deletions
This file was deleted.

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Go Tools
2+
3+
This subrepository holds the source for various packages and tools that support
4+
the Go programming language.
5+
6+
Some of the tools, `godoc` and `vet` for example, are included in binary Go
7+
distributions.
8+
9+
Others, including the Go `guru` and the test coverage tool, can be fetched with
10+
`go get`.
11+
12+
Packages include a type-checker for Go and an implementation of the
13+
Static Single Assignment form (SSA) representation for Go programs.
14+
15+
## Download/Install
16+
17+
The easiest way to install is to run `go get -u golang.org/x/tools/...`. You can
18+
also manually git clone the repository to `$GOPATH/src/golang.org/x/tools`.
19+
20+
## Report Issues / Send Patches
21+
22+
This repository uses Gerrit for code changes. To learn how to submit changes to
23+
this repository, see https://golang.org/doc/contribute.html.
24+
25+
The main issue tracker for the tools repository is located at
26+
https://github.com/golang/go/issues. Prefix your issue with "x/tools/(your
27+
subdir):" in the subject line, so it is easy to find.

0 commit comments

Comments
 (0)