README: add links to useful resources

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/term or https://github.com/golang/term
figure out how to get started with development.

Change-Id: I8e1b1f1204f4c80acc5fd2cd28ab2efe4403c015
Reviewed-on: https://go-review.googlesource.com/49890
Reviewed-by: Kevin Burke <kev@inburke.com>
This commit is contained in:
Kevin Burke
2017-07-18 20:39:53 -07:00
parent fcc174f3e9
commit aa45bf8df0
2 changed files with 17 additions and 1 deletions

1
README
View File

@@ -1 +0,0 @@
This repository provides Go terminal and console support packages.

17
README.md Normal file
View File

@@ -0,0 +1,17 @@
# Go terminal/console support
This repository provides Go terminal and console support packages.
## Download/Install
The easiest way to install is to run `go get -u golang.org/x/term`. You can
also manually git clone the repository to `$GOPATH/src/golang.org/x/term`.
## Report Issues / Send Patches
This repository uses Gerrit for code changes. To learn how to submit changes to
this repository, see https://golang.org/doc/contribute.html.
The main issue tracker for the term repository is located at
https://github.com/golang/go/issues. Prefix your issue with "x/term:" in the
subject line, so it is easy to find.