jrmi / canviz

Automatically exported from code.google.com/p/canviz
0 stars 0 forks source link

Clearly indicate which files are required #77

Open GoogleCodeExporter opened 8 years ago

GoogleCodeExporter commented 8 years ago
There are many shell files, examples etc mixed with required files you should 
deploy.

The documentation and examples should clearly be separated from libraries 
distributed files one has to include in its own project.

Original issue reported on code.google.com by wer...@beroux.com on 19 Aug 2014 at 8:22

GoogleCodeExporter commented 8 years ago
You're quite right! It's a bit of a mess at the moment.

Are you looking at the 0.1 code or the latest in the repository trunk? The 
trunk is a bit better, but not yet great.

Do you have any suggestions for how the files should be organized? Are there 
other client-side JavaScript libraries I should look to for an example? What do 
users expect?

Original comment by ryandesi...@gmail.com on 4 Sep 2014 at 6:49

GoogleCodeExporter commented 8 years ago
If there is a build process involved:

https://github.com/madrobby/zepto
https://github.com/jquery/jquery
https://github.com/zurb/foundation

If there is no build process involved a 'dist/' folder sounds good:

docs/ - Documents
dist/ - Files required somewhere until public_html / www_root
src/ - Whatever source code to build dist
tests/ - Tests
examples/ - Demo code using dist/ as usage example
README

In either case, the README should tell how to get those files and only
those do whatever project one has.

Original comment by wer...@beroux.com on 8 Sep 2014 at 7:14