Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(233)

Unified Diff: README.md

Issue 1661873002: Improve documentation organization. (Closed) Base URL: git@github.com:dart-lang/test@master
Patch Set: Created 4 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | doc/json_reporter.md » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: README.md
diff --git a/README.md b/README.md
index 44957eac98577c3a221bd0526c1d67210af0f9cf..beda9ef1825c43803c57580ae7c67fca446211e6 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,20 @@
`test` provides a standard way of writing and running tests in Dart.
+* [Writing Tests](#writing-tests)
+* [Running Tests](#running-tests)
+ * [Restricting Tests to Certain Platforms](#restricting-tests-to-certain-platforms)
+ * [Platform Selector Syntax](#platform-selector-syntax)
+ * [Running Tests on Dartium](#running-tests-on-dartium)
+* [Asynchronous Tests](#asynchronous-tests)
+* [Running Tests With Custom HTML](#running-tests-with-custom-html)
+* [Configuring Tests](#configuring-tests)
+ * [Skipping Tests](#skipping-tests)
+ * [Timeouts](#timeouts)
+ * [Platform-Specific Configuration](#platform-specific-configuration)
+* [Debugging](#debugging)
+* [Testing with `barback`](#testing-with-barback)
+* [Further Reading](#further-reading)
+
## Writing Tests
Tests are specified using the top-level [`test()`][test] function, and test
@@ -319,7 +334,7 @@ void main() {
[expectAsync]: http://www.dartdocs.org/documentation/test/latest/index.html#test/test@id_expectAsync
-## Running Tests with Custom HTML
+## Running Tests With Custom HTML
By default, the test runner will generate its own empty HTML file for browser
tests. However, tests that need custom HTML can create their own files. These
@@ -550,3 +565,10 @@ Check out the [API docs][api] for detailed information about all the functions
available to tests.
[api]: http://www.dartdocs.org/documentation/test/latest/index.html
+
+The test runner also supports a machine-readable JSON-based reporter. This
+reporter allows the test runner to be wrapped and its progress presented in
+custom ways (for example, in an IDE). See [the protocol documentation][json] for
+more details.
+
+[json]: https://github.com/dart-lang/test/blob/master/doc/json_reporter.md
« no previous file with comments | « no previous file | doc/json_reporter.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698