Skip to content

Some READEME cleanup #241

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

Merged
merged 1 commit into from
Jul 21, 2017
Merged

Some READEME cleanup #241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 7 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,18 +54,18 @@ Once you have `source_gen` setup, you should reference the examples below.

## Creating a generator

Extend the `Generator` class to plug into `source_gen`.
Extend the `Generator` or `GeneratorForAnnotation` class and `source_gen` will
call your generator for a Dart library or for each element within a library
tagged with the annotation you are interested in.

* [Trivial example][]
* [Included generators][]

## Running generators

`source_gen` is based on the [`build`][build] package.

See `build.dart` and `watch.dart` in the `tool` directory. Both reference
`tool/phases.dart`, which contains information mapping `source_gen` generators
to target files.
`source_gen` is based on the [`build`][build] package. Use a `PartBuilder` or
`LibraryBuilder` to wrap your `Generator` as a `Builder` which can be run using
a build system compatible with `package:build`. See the build package
documentation for information on running Builders.

## FAQ

Expand Down Expand Up @@ -122,7 +122,6 @@ detail*.

[Dart transformers]: https://www.dartlang.org/tools/pub/assets-and-transformers.html
[Trivial example]: https://github.com/dart-lang/source_gen/blob/master/test/src/comment_generator.dart
[Included generators]: https://github.com/dart-lang/source_gen/tree/master/lib/generators
[build.dart]: https://github.com/dart-lang/source_gen/blob/master/build.dart
[generate]: http://www.dartdocs.org/documentation/source_gen/latest/index.html#source_gen/source_gen@id_generate
[build]: http://www.dartdocs.org/documentation/source_gen/latest/index.html#source_gen/source_gen@id_build