aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..48a3e08
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# git-codereview
+
+The git-codereview tool is a command-line tool for working with Gerrit.
+
+## Download/Install
+
+The easiest way to install is to run `go get -u golang.org/x/review`. You can
+also manually git clone the repository to `$GOPATH/src/golang.org/x/review`.
+
+The review binary itself is available at `golang.org/x/review/git-codereview`.
+Run `git codereview hooks` to install Gerrit hooks for your git repository.
+
+## 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 review repository is located at
+https://github.com/golang/go/issues. Prefix your issue with "x/review:" in the
+subject line, so it is easy to find.