Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(992)

Unified Diff: pkg/polymer/README.md

Issue 53243002: Use pub-build in todomvc and sample template app from the editor (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 7 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: pkg/polymer/README.md
diff --git a/pkg/polymer/README.md b/pkg/polymer/README.md
index 3ab84b8edb688a5a071f7a101f0b7198f18f3f3f..d55786d0dd5d2cda0d766d1c11b66da158389541 100644
--- a/pkg/polymer/README.md
+++ b/pkg/polymer/README.md
@@ -48,26 +48,53 @@ project broken on each release. Using a version range lets you upgrade your
package at your own pace. You can find the latest version number at
<https://pub.dartlang.org/packages/polymer>.
+Building and Deploying
+----------------------
-Running Tests
--------------
+To build a deployable version of your app, add the polymer transformers to your
+pubspec.yaml file:
+
+```yaml
+transformers:
+- polymer
+```
+
+Then, run `pub build`. The polymer transformers assume all files under `web`
+are possible entry points, this can be adjusted with arguments in your
+pubspec.yaml file. For example, you can say only `web/index.html` is an entry
+point as follows:
+
+```yaml
+transformers:
+- polymer:
+ entry_points: web/index.html
+```
+
+Here is a list of arguments used by the polymer transformers:
+* js: whether to load JS code directly. By default polymer converts your app's
+ html file to load the compiled JS code directly. Setting this parameter to
+ false will keep a dart script tag and the `dart.js` script tag on the page.
-Install dependencies using the [Pub Package Manager][pub].
-```bash
-pub install
+* csp: whether to load a Content Security Policy (CSP) compliant JS file.
+ Dart2js generates two JS files, one that is not CSP compilant and one that is.
+ By default, polymer uses the former becuase it's likely more efficient, but
+ you can choose the latter by setting this flag.
-# Run command line tests and automated end-to-end tests. It needs two
-# executables on your path: `dart` and `content_shell` (see below
-# for links to download `content_shell`)
-test/run.sh
+* entry_points: can be a list of entry points or, for convenience, a single
+ entry point as shown above.
+
+For example, this specification includes 2 entrypoints and chooses the CSP
+compliant JS file:
+
+```yaml
+transformers:
+- polymer:
+ entry_points:
+ - web/index.html
+ - web/index2.html
+ csp: true
```
-Note: To run browser tests you will need to have [content_shell][cs],
-which can be downloaded prebuilt for [Ubuntu Lucid][cs_lucid],
-[Windows][cs_win], or [Mac][cs_mac]. You can also build it from the
-[Dartium and content_shell sources][dartium_src].
-For Linux users all the necessary fonts must be installed see
-<https://code.google.com/p/chromium/wiki/LayoutTestsLinux>.
Contacting Us
-------------

Powered by Google App Engine
This is Rietveld 408576698