jmpressjs / jmpress.js

A jQuery plugin to build a website on the infinite canvas
http://jmpressjs.github.com/jmpress.js
1.5k stars 237 forks source link

Missing directory in repo: “dist” #61

Closed remino closed 12 years ago

remino commented 12 years ago

After cloning the repo and opening the index.html file in its root directory, I noticed two needed files are missing, both in the non-existant “dist” directory.

I downloaded them both from the demo site, and now I can view index.html.

Shouldn't those files be included in the repo?

remino commented 12 years ago

Never mind. I didn't look far enough. The files were in the gh-pages branch.

https://github.com/shama/jmpress.js/tree/gh-pages

shama commented 12 years ago

dist/ is automatically generated. But @sokra why don't we have dist in the master/dev? Generated and force pushed on releases. (I realize this might have been something I did :)

sokra commented 12 years ago

I'm not sure...

They are downloadable here: http://shama.github.com/jmpress.js/docs/#docs-downloads

After cloning they can be generated: grunt http://shama.github.com/jmpress.js/docs/#docs-contribute

The question is: Are generated files part of the repo?

I thought no, because in my opinion only the source should be in to repo.

https://github.com/jquery/jquery uses grunt too and have there output in dist too. They gitignored dist too and it's not part of the repo.

we had dist in gitignore since start, but force pushed it. Sounds weird for me.

@remino Copying them from gh-pages is the wrong approach. Follow the instructions for contributing:

-> install node.js (http://nodejs.org)
npm install --dev
npm install grunt -g
grunt
shama commented 12 years ago

Ah ok, I agree. I'll rebase that commit on dev. Thanks @sokra!

remino commented 12 years ago

Forgot to reply.

I agree that compiled files should not be part of the repo and the above instructions should be followed instead. Thank you!