From d3b1f47b93aee8157ff6adab86190df345474b31 Mon Sep 17 00:00:00 2001 From: Janice Collins Date: Fri, 20 Aug 2021 10:21:22 -0700 Subject: [PATCH] Add a blurb to the README about requiring analysis --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 01fb7d69d5..6c41da2dd2 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,9 @@ Run `pub global activate dartdoc` to install the latest version of dartdoc compa ## Generating docs -Run `dartdoc` from the root directory of a package. Here is an example of dartdoc documenting itself: +Run `dartdoc` from the root directory of a package. Your package must analyze without errors +with `dart analyze` or `flutter analyze` as appropriate. Here is an example of dartdoc documenting +itself: ``` $ dartdoc