Closed Bug 1125775 Opened 7 years ago Closed 7 years ago

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

Categories

(Hello (Loop) :: Client, defect)

defect
Not set
normal
Points:
1

Tracking

(Not tracked)

RESOLVED FIXED
mozilla38
Iteration:
38.1 - 26 Jan

People

(Reporter: standard8, Assigned: standard8)

References

Details

Attachments

(1 file)

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.
Iteration: --- → 38.1 - 26 Jan
Points: --- → 1
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.
Attachment #8554472 - Flags: review?(nperriault) → review+
(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.
https://hg.mozilla.org/integration/fx-team/rev/0f87f9d002c1
Target Milestone: --- → mozilla38
https://hg.mozilla.org/mozilla-central/rev/0f87f9d002c1
Status: NEW → RESOLVED
Closed: 7 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.