@@ -21,9 +21,11 @@ rebuilds are _incremental_ - inspired by tools such as [Bazel][].
21
21
22
22
> ** NOTE** : Are you a user of this package? You may be interested in
23
23
> simplified user-facing documentation, such as our
24
- > [ getting started guide] [ getting-started-link ] .
24
+ > [ getting started guide] [ getting-started-link ] and [ faq ] [ faq-link ] .
25
25
26
- [ getting-started-link ] : https://goo.gl/b9o2j6
26
+ [ getting-started-link ] : https://github.com/dart-lang/build/blob/master/docs/getting_started.md
27
+ [ faq-link ] : https://github.com/dart-lang/build/blob/master/docs/faq.md
28
+ [ other-docs-link ] : https://github.com/dart-lang/build/tree/master/docs
27
29
28
30
* [ Installation] ( #installation )
29
31
* [ Usage] ( #usage )
@@ -32,13 +34,14 @@ rebuilds are _incremental_ - inspired by tools such as [Bazel][].
32
34
* [ Outputs] ( #outputs )
33
35
* [ Source control] ( #source-control )
34
36
* [ Publishing packages] ( #publishing-packages )
37
+ * [ Docs] ( #docs )
35
38
* [ Contributing] ( #contributing )
36
39
* [ Testing] ( #testing )
37
40
38
41
## Installation
39
42
40
43
This package is intended to support development of Dart projects with
41
- [ ` package:build ` ] [ ] . In general, add it to your [ ` pubspec.yaml ` ] [ pubspec ]
44
+ [ ` package:build ` ] [ ] . In general, add it to your [ ` pubspec.yaml ` ] [ pubspec ]
42
45
as a [ dev_dependencies] [ ] by running the following command.
43
46
44
47
``` console
@@ -56,6 +59,12 @@ also provide a `build.yaml` with the configuration. See the
56
59
57
60
To have web code compiled to js add a ` dev_dependency ` on ` build_web_compilers ` .
58
61
62
+ ## Docs
63
+
64
+ More comprehensive documentation is stored in this repository, under the
65
+ [ docs] [ other-docs-link ] directory. If you find something is undocumented, please
66
+ file an issue.
67
+
59
68
### Built-in Commands
60
69
61
70
The ` build_runner ` package exposes a binary by the same name, which can be
0 commit comments