Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs to point at the FAQ and general docs #3620

Merged
merged 2 commits into from
Dec 4, 2023
Merged

Update docs to point at the FAQ and general docs #3620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3d2ae0
add link to FAQ as well as the general docs directory
jakemac53 Dec 4, 2023
621eb79
update pubspec/changelog
jakemac53 Dec 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions build_runner/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 2.4.8-wip

- Update README.md to point to the FAQ and other docs.

## 2.4.7

- Fix broken link in README.md.
Expand Down
15 changes: 12 additions & 3 deletions build_runner/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ rebuilds are _incremental_ - inspired by tools such as [Bazel][].

> **NOTE**: Are you a user of this package? You may be interested in
> simplified user-facing documentation, such as our
> [getting started guide][getting-started-link].
> [getting started guide][getting-started-link] and [faq][faq-link].

[getting-started-link]: https://goo.gl/b9o2j6
[getting-started-link]: https://github.com/dart-lang/build/blob/master/docs/getting_started.md
[faq-link]: https://github.com/dart-lang/build/blob/master/docs/faq.md
[other-docs-link]: https://github.com/dart-lang/build/tree/master/docs

* [Installation](#installation)
* [Usage](#usage)
Expand All @@ -32,13 +34,14 @@ rebuilds are _incremental_ - inspired by tools such as [Bazel][].
* [Outputs](#outputs)
* [Source control](#source-control)
* [Publishing packages](#publishing-packages)
* [Docs](#docs)
* [Contributing](#contributing)
* [Testing](#testing)

## Installation

This package is intended to support development of Dart projects with
[`package:build`][]. In general, add it to your [`pubspec.yaml`][pubspec]
[`package:build`][]. In general, add it to your [`pubspec.yaml`][pubspec]
as a [dev_dependencies][] by running the following command.

```console
Expand All @@ -56,6 +59,12 @@ also provide a `build.yaml` with the configuration. See the

To have web code compiled to js add a `dev_dependency` on `build_web_compilers`.

## Docs

More comprehensive documentation is stored in this repository, under the
[docs][other-docs-link] directory. If you find something is undocumented, please
file an issue.

### Built-in Commands

The `build_runner` package exposes a binary by the same name, which can be
Expand Down
2 changes: 1 addition & 1 deletion build_runner/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: build_runner
version: 2.4.7
version: 2.4.8-wip
description: A build system for Dart code generation and modular compilation.
repository: https://github.com/dart-lang/build/tree/master/build_runner

Expand Down
Loading