1125775 - Add information about the front-end unit tests and ui-showcase to Loop's README.txt

Status: RESOLVED FIXED

(Hello (Loop) :: Client, defect)

Description

[Mark Banner (:standard8)]

This is a partial stopgap whilst we sort out our documentation - add more information to README.txt about the front-end unit tests and the ui-showcase.

I know not everyone reads readmes but for now, at least, it gives us a place to add basic information.

Comment 1

[Mark Banner (:standard8)]

Attachment: Add information about the front-end unit tests and ui-showcase to Loop's README.txt.

Comment 2

[Nicolas Perriault (:NiKo`) — needinfo me if you need my attention]

Comment on attachment 8554472 [details] [diff] [review]
Add information about the front-end unit tests and ui-showcase to Loop's README.txt.

Review of attachment 8554472 [details] [diff] [review]:
-----------------------------------------------------------------

LGTM with comments addressed.

::: browser/components/loop/README.txt
@@ +24,5 @@
> +Once installed, run build-jsx with the --watch option from
> +browser/components/loop, eg.:
> +
> +    cd browser/components/loop
> +    ./build-jsx --watch

Would be great to have instructions for Windows users as well. Maybe in a part two or with a new dedicated bug.

@@ +69,5 @@
>  
>  
> +UI-Showcase
> +===========
> +This is a tool giving the layouts for all the frontend views of Loop, allowing debugging and testing of css layouts.

Nit: +and local component behavior.

Comment 3

[Mark Banner (:standard8)]

(In reply to Nicolas Perriault (:NiKo`) — needinfo me if you need my attention from comment #2)
> ::: browser/components/loop/README.txt
> @@ +24,5 @@
> > +Once installed, run build-jsx with the --watch option from
> > +browser/components/loop, eg.:
> > +
> > +    cd browser/components/loop
> > +    ./build-jsx --watch
> 
> Would be great to have instructions for Windows users as well. Maybe in a
> part two or with a new dedicated bug.

I think we should wrap it up in bug 1108088 - I'm trying to get my windows vm up to date at the moment so that I can play around and see what's really going on there.

> > +UI-Showcase
> > +===========
> > +This is a tool giving the layouts for all the frontend views of Loop, allowing debugging and testing of css layouts.
> 
> Nit: +and local component behavior.

Fixed.

Comment 4

[Mark Banner (:standard8)]

https://hg.mozilla.org/integration/fx-team/rev/0f87f9d002c1

Comment 5

[Ekanan Ketunuti]

https://hg.mozilla.org/mozilla-central/rev/0f87f9d002c1