Issue 77 in canviz: Clearly indicate which files are required

[can...@googlecode.com]

Status: New
Owner: ----
Labels: Type-Defect Priority-Medium

New issue 77 by wer...@beroux.com: Clearly indicate which files are required
http://code.google.com/p/canviz/issues/detail?id=77

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.

--
You received this message because this project is configured to send all
issue notifications to this address.
You may adjust your notification preferences at:
https://code.google.com/hosting/settings

[can...@googlecode.com]

Comment #1 on issue 77 by ryandesi...@gmail.com: Clearly indicate which
files are required
https://code.google.com/p/canviz/issues/detail?id=77

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?

[can...@googlecode.com]

Comment #2 on issue 77 by wer...@beroux.com: Clearly indicate which files
are required
https://code.google.com/p/canviz/issues/detail?id=77

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.