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

Side by Side Diff: pkg/polymer/README.md

Issue 23453034: Added library-level comments for polymer and polymer_expressions (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: integrated Justin's and John's feedback comments Created 7 years, 3 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 unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « no previous file | pkg/polymer/lib/polymer.dart » ('j') | pkg/polymer/lib/polymer.dart » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 Polymer.dart 1 Polymer.dart
2 ============ 2 ============
3 3
4 Polymer is a new type of library for the web, built on top of Web Components, 4 Polymer.dart is a set of comprehensive UI and utility components
5 and designed to leverage the evolving web platform on modern browsers. 5 for building web applications.
6 With Polymer.dart's custom elements, templating, data binding,
7 and other features,
8 you can quickly build structured, encapsulated, client-side web apps.
6 9
7 Polymer.dart is a Dart port of Polymer created and maintained by the Dart team. 10 Polymer.dart is a Dart port of
11 [Polymer][polymer] created and maintained by the Dart team.
8 The Dart team is collaborating with the Polymer team to ensure that polymer.dart 12 The Dart team is collaborating with the Polymer team to ensure that polymer.dart
9 elements and polyfills are fully compatible with Polymer. 13 elements and polyfills are fully compatible with Polymer.
10 14
11 For more information about Polymer, see <http://www.polymer-project.org/>. 15 Polymer.dart replaces Web UI, which has been deprecated.
12 For more information about Dart, see <http://www.dartlang.org/>. 16
17
18 Learn More
19 ----------
20
21 * The [Polymer.dart][home_page] home page
22 contains a list of features, project status,
23 installation instructions, how to upgrade from Web UI,
Kathy Walrath 2013/09/13 16:44:16 "how to upgrade from Web UI" isn't parallel with t
mem 2013/09/13 17:05:58 Done.
24 and links to other documentation.
25
26 * See our [TodoMVC][] example by opening up the Dart Editor's Welcome Page and
27 selecting "TodoMVC".
28
29 * For more information about Dart, see <http://www.dartlang.org/>.
30
31 * When you use this package,
32 you automatically get the
33 [polymer_expressions][polymer_expressions] package,
Kathy Walrath 2013/09/13 16:44:16 I think the second [] can be empty
mem 2013/09/13 17:05:58 Done.
34 which provides an expressive syntax for use with templates.
35
13 36
14 Try It Now 37 Try It Now
15 ----------- 38 -----------
16 Add the polymer.dart package to your pubspec.yaml file: 39 Add the polymer.dart package to your pubspec.yaml file:
17 40
18 ```yaml 41 ```yaml
19 dependencies: 42 dependencies:
20 polymer: any 43 polymer: any
21 ``` 44 ```
22 45
23 Instead of using `any`, we recommend using version ranges to avoid getting your 46 Instead of using `any`, we recommend using version ranges to avoid getting your
24 project broken on each release. Using a version range lets you upgrade your 47 project broken on each release. Using a version range lets you upgrade your
25 package at your own pace. You can find the latest version number at 48 package at your own pace. You can find the latest version number at
26 <https://pub.dartlang.org/packages/polymer>. 49 <https://pub.dartlang.org/packages/polymer>.
27 50
28 51
29 Learn More
30 ----------
31
32 **Note**: these documents are currently out of date.
33
34 * [Read an overview][overview]
35 * [Setup your tools][tools]
36 * [Browse the features][features]
37 * [Dive into the specification][spec]
38
39 See our [TodoMVC][] example by opening up the Dart Editor's Welcome Page and
40 selecting "TodoMVC".
41
42 Running Tests 52 Running Tests
43 ------------- 53 -------------
44 54
45 Dependencies are installed using the [Pub Package Manager][pub]. 55 Install dependencies using the [Pub Package Manager][pub].
46 ```bash 56 ```bash
47 pub install 57 pub install
48 58
49 # Run command line tests and automated end-to-end tests. It needs two 59 # Run command line tests and automated end-to-end tests. It needs two
50 # executables on your path: `dart` and `content_shell` (see below 60 # executables on your path: `dart` and `content_shell` (see below
51 # for links to download `content_shell`) 61 # for links to download `content_shell`)
52 test/run.sh 62 test/run.sh
53 ``` 63 ```
54 Note: to run browser tests you will need to have [content_shell][cs], 64 Note: To run browser tests you will need to have [content_shell][cs],
55 which can be downloaded prebuilt for [Ubuntu Lucid][cs_lucid], 65 which can be downloaded prebuilt for [Ubuntu Lucid][cs_lucid],
56 [Windows][cs_win], or [Mac][cs_mac]. You can also build it from the 66 [Windows][cs_win], or [Mac][cs_mac]. You can also build it from the
57 [Dartium and content_shell sources][dartium_src]. 67 [Dartium and content_shell sources][dartium_src].
58 68
59 For Linux users all the necessary fonts must be installed see 69 For Linux users all the necessary fonts must be installed see
60 <https://code.google.com/p/chromium/wiki/LayoutTestsLinux>. 70 <https://code.google.com/p/chromium/wiki/LayoutTestsLinux>.
61 71
62 Contacting Us 72 Contacting Us
63 ------------- 73 -------------
64 74
(...skipping 11 matching lines...) Expand all
76 [cs_win]: http://gsdview.appspot.com/dartium-archive/continuous/drt-win.zip 86 [cs_win]: http://gsdview.appspot.com/dartium-archive/continuous/drt-win.zip
77 [dartium_src]: http://code.google.com/p/dart/wiki/BuildingDartium 87 [dartium_src]: http://code.google.com/p/dart/wiki/BuildingDartium
78 [TodoMVC]: http://addyosmani.github.com/todomvc/ 88 [TodoMVC]: http://addyosmani.github.com/todomvc/
79 [issues]: http://dartbug.com/new 89 [issues]: http://dartbug.com/new
80 [mailinglist]: https://groups.google.com/a/dartlang.org/forum/?fromgroups#!forum /web-ui 90 [mailinglist]: https://groups.google.com/a/dartlang.org/forum/?fromgroups#!forum /web-ui
81 [devlist]: https://groups.google.com/a/dartlang.org/forum/?fromgroups#!forum/web -ui-dev 91 [devlist]: https://groups.google.com/a/dartlang.org/forum/?fromgroups#!forum/web -ui-dev
82 [overview]: http://www.dartlang.org/articles/dart-web-components/ 92 [overview]: http://www.dartlang.org/articles/dart-web-components/
83 [tools]: https://www.dartlang.org/articles/dart-web-components/tools.html 93 [tools]: https://www.dartlang.org/articles/dart-web-components/tools.html
84 [spec]: https://www.dartlang.org/articles/dart-web-components/spec.html 94 [spec]: https://www.dartlang.org/articles/dart-web-components/spec.html
85 [features]: https://www.dartlang.org/articles/dart-web-components/summary.html 95 [features]: https://www.dartlang.org/articles/dart-web-components/summary.html
96 [home_page]: https://www.dartlang.org/polymer-dart/
97 [polymer_expressions]: http://pub.dartlang.org/packages/polymer_expressions/
98 [polymer]: http://www.polymer-project.org/
OLDNEW
« no previous file with comments | « no previous file | pkg/polymer/lib/polymer.dart » ('j') | pkg/polymer/lib/polymer.dart » ('J')

Powered by Google App Engine
This is Rietveld 408576698