Local Preview instructions

mobify / pinny

A mobile-first content fly-in UI plugin

MIT License

23 stars 4 forks source link

Local Preview instructions #68

Closed nastiatikk closed 9 years ago

nastiatikk commented 9 years ago

I am not sure about these two steps: npm install -g grunt-cli to install Grunt npm install -g bower to install Bower

Should they be run on the first project run or it's a one-time installation like node.js?

vmarta commented 9 years ago

@nastiatikk they're for one-time installation like installing node.

highruned commented 9 years ago

As denoted by the -g parameter (global)

nastiatikk commented 9 years ago

@ry5n @jeffkamo Any suggestions on this updated Contribution section?

ry5n commented 9 years ago

I don’ think the changes to the “Requirements” section clarify anything. @nastiatikk if you were confused by the original, what did you find confusing?
Same with renaming the “Steps” section to “Running”
The new “Building Variations” heading was confusing to me, because I thought it was intended to be instructions on building new Variations (?) of Pinny. Now I guess that this is intended to document the other grunt tasks that are available with the project. A section called “Available Grunt Tasks” might be better.
Although a section called Contributing is common for project readmes, I’m not sure that’s what this section was aiming for. The Contributing section usually contains instructions for people who want to help maintain/improve the project. What is there now seems more focused on creating a custom build as a fork (?). Dunno.

jeffkamo commented 9 years ago

It seems like ultimately all that was wanted was a simple "How to Preview Locally" instructions.

So I don't think it's necessary to rename the headings or add the "Building Variations" section.

Listing the grunt tasks might help, or simply having a bit of "use grunt serve to preview the site at localhost:3000" mentioned after the build steps would probably suffice.

nastiatikk commented 9 years ago

'Requirements' changes is my mistake. I changed it and then rolled back but I see I did it with mistakes
The same with 'Running'
I will rename title for Building Variations
I will rename this section to 'Working with Pinny locally', it will be more specific.

nastiatikk commented 9 years ago

@ry5n @jeffkamo @kpeatt @avelinet @cole-sanderson @mlworks I've updated Pinny's 'How to' instructions based on all the comments above. Please review.

jeffkamo commented 9 years ago

Would love to hear an engi's thoughts on these changes. @ericmuyser @vmarta @tedtate

scalvert commented 9 years ago

Made some quick changes to terminology. LGTM!

:+1: