Add a README for path.

Add a README for path.

Committed: https://code.google.com/p/dart/source/detail?r=17487

[Emily Fortuna, 2013-01-23 02:00:54]

https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md
File pkg/path/README.md (right):

https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md#newcode111
pkg/path/README.md:111: ### String join(String part1, [String part2, String
part3, ...])
do we need to actually list all of these functions in the readme? It seems like
the docs would be the main place for this, and here should just give a summary.
Plus, not that this is going to change all that much, but if you change the
functionality, now you'll have to edit the regular docs and the docs here...

https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md#newcode260
pkg/path/README.md:260: Current, Dart has no way of encapsulating
configuration-specific code. Ideally,
typo "Current" -> "Currently"

https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md#newcode294
pkg/path/README.md:294: with path's of a specific style, you can construct a
`path.Builder` for that
this last sentence is an important point, that you might want to highlight a
little higher up in the readme, or in a slightly more visible spot.

https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md#newcode309
pkg/path/README.md:309: same directory.
having said all that, are you inviting users to file bugs at dartbug.com/new?
(if so, say so.... this section seems like a lead up to that idea) :-)

[Bob Nystrom, 2013-01-23 17:46:33]

Thanks!

https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md
File pkg/path/README.md (right):

https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md#newcode111
pkg/path/README.md:111: ### String join(String part1, [String part2, String
part3, ...])
On 2013/01/23 02:00:54, Emily Fortuna wrote:
> do we need to actually list all of these functions in the readme? It seems
like
> the docs would be the main place for this, and here should just give a
summary.

It is redundant, but currently pub.dartlang.org doesn't show the API docs for
packages. Until it does, I figured this was the simplest way to get the docs out
there. When pub.dartlang.org is including generated docs, I'll ditch all of this
stuff.

> Plus, not that this is going to change all that much, but if you change the
> functionality, now you'll have to edit the regular docs and the docs here...

Yeah, it's a drag. But I want to get the docs where people can see them.

https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md#newcode260
pkg/path/README.md:260: Current, Dart has no way of encapsulating
configuration-specific code. Ideally,
On 2013/01/23 02:00:54, Emily Fortuna wrote:
> typo "Current" -> "Currently"

Done.

https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md#newcode294
pkg/path/README.md:294: with path's of a specific style, you can construct a
`path.Builder` for that
On 2013/01/23 02:00:54, Emily Fortuna wrote:
> this last sentence is an important point, that you might want to highlight a
> little higher up in the readme, or in a slightly more visible spot.

Done.

https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md#newcode309
pkg/path/README.md:309: same directory.
On 2013/01/23 02:00:54, Emily Fortuna wrote:
> having said all that, are you inviting users to file bugs at dartbug.com/new?
> (if so, say so.... this section seems like a lead up to that idea) :-)

Great idea. Done!

[Emily Fortuna, 2013-01-23 18:36:57]

lgtm!

https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md
File pkg/path/README.md (right):

https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md#newcode111
pkg/path/README.md:111: ### String join(String part1, [String part2, String
part3, ...])
On 2013/01/23 17:46:33, Bob Nystrom wrote:
> On 2013/01/23 02:00:54, Emily Fortuna wrote:
> > do we need to actually list all of these functions in the readme? It seems
> like
> > the docs would be the main place for this, and here should just give a
> summary.
> 
> It is redundant, but currently http://pub.dartlang.org doesn't show the API
docs for
> packages. Until it does, I figured this was the simplest way to get the docs
out
> there. When http://pub.dartlang.org is including generated docs, I'll ditch
all of this
> stuff.
> 
> > Plus, not that this is going to change all that much, but if you change the
> > functionality, now you'll have to edit the regular docs and the docs here...
> 
> Yeah, it's a drag. But I want to get the docs where people can see them.

Sigh. can you file a low priority bug or add a TODO in the main documentation to
update this README when the docs are actually available? :-)

[Bob Nystrom, 2013-01-23 18:58:21]

On 2013/01/23 18:36:57, Emily Fortuna wrote:
> lgtm!
> 
> https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md
> File pkg/path/README.md (right):
> 
> https://codereview.chromium.org/12047035/diff/1/pkg/path/README.md#newcode111
> pkg/path/README.md:111: ### String join(String part1, [String part2, String
> part3, ...])
> On 2013/01/23 17:46:33, Bob Nystrom wrote:
> > On 2013/01/23 02:00:54, Emily Fortuna wrote:
> > > do we need to actually list all of these functions in the readme? It seems
> > like
> > > the docs would be the main place for this, and here should just give a
> > summary.
> > 
> > It is redundant, but currently http://pub.dartlang.org doesn't show the API
> docs for
> > packages. Until it does, I figured this was the simplest way to get the docs
> out
> > there. When http://pub.dartlang.org is including generated docs, I'll ditch
> all of this
> > stuff.
> > 
> > > Plus, not that this is going to change all that much, but if you change
the
> > > functionality, now you'll have to edit the regular docs and the docs
here...
> > 
> > Yeah, it's a drag. But I want to get the docs where people can see them.
> 
> Sigh. can you file a low priority bug or add a TODO in the main documentation
to
> update this README when the docs are actually available? :-)

Done! http://code.google.com/p/dart/issues/detail?id=8072