Skip to content

Commit

Permalink
docs(modules_dart): add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yjbanov authored and mhevery committed May 8, 2015
1 parent 09b39bf commit 61b69c6
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions modules_dart/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
This directory contains pure Dart packages that use standard pub layout.

# Working with an existing package

1. Run `gulp build.dart`
1. Open the package in any Dart IDE of your choice
1. Tada!

You do not need to rerun step 1 if you are only making changes in
`modules_dart`. However, you do need to run it again after you make a change
in `modules`. This is because these packages depend on code inside the `dist`
directory via `dependency_overrides`. Code in `modules` need to be transpiled
into `dist` before the IDE can "feel" your changes in `modules`.

# Creating a new package

1. Create a new directory with its own `pubspec.yaml` and standard pub layout.
1. Add both a normal dependency on `angular2` _and_ a `dependency_overrides`,
like this:

```yaml
version: 0.0.0
dependencies:
angular2: '0.0.0'
dependency_overrides:
angular2:
path: ../../dist/dart/angular2
```
The publishing script will automatically rewrite version numbers, so use
`0.0.0` both for your package and `angular2` version. Similarly, do not
include `authors` and `homepage`, as they will be auto-populated. However,
do provide `description`, `name` (prefixed with `angular2_`), `dependencies`,
and `dev_dependencies`.

0 comments on commit 61b69c6

Please sign in to comment.