From: Josh Bleecher Snyder <josharian@gmail.com>
Date: Mon, 24 Jul 2017 17:17:15 +0000 (-0700)
Subject: test: add README
X-Git-Tag: go1.9rc2~1^2~30
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=e157fac02d4700e9fa8e1c30265a2d90a51be6f3;p=gostls13.git

test: add README

Updates #21034

Change-Id: I951fb48ab3b9ed54d225c11879db8f09048a36a3
Reviewed-on: https://go-review.googlesource.com/50950
Reviewed-by: Rob Pike <r@golang.org>
---

diff --git a/test/README.md b/test/README.md
new file mode 100644
index 0000000000..ca6a8c6580
--- /dev/null
+++ b/test/README.md
@@ -0,0 +1,15 @@
+The test directory contains tests of the Go tool chain and runtime.
+It includes black box tests, regression tests, and error output tests.
+They are run as part of all.bash.
+
+To run just these tests, execute:
+
+    go run run.go
+
+Standard library tests should be written as regular Go tests in the appropriate package.
+
+The tool chain and runtime also have regular Go tests in their packages.
+The main reasons to add a new test to this directory are:
+
+* it is most naturally expressed using the test runner; or
+* it is also applicable to `gccgo` and other Go tool chains.