Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Elaborate "Usage" in README #5

Open
mr-niels-christensen opened this issue Oct 8, 2015 · 3 comments
Open

Elaborate "Usage" in README #5

mr-niels-christensen opened this issue Oct 8, 2015 · 3 comments
Labels
Milestone

Comments

@mr-niels-christensen
Copy link

This project sounds great, but while the "Usage" section may be obvious to a bower/require/D3 veteran, I'm mystified. It'd be great if you could clarify some of the below questions!

Where should the following JSON be stored (and why)? Are the paths generally useful or should they be modified in every project? I was considering a .bowerrc with "directory": "src/components" or similar - would it be simple to change the paths to that configuration? Does these path need to be specified before doing bower install graphviz-d3-renderer --save?

paths: {
    d3: '/bower_components/d3/d3',
    "dot-checker": '/bower_components/graphviz-d3-renderer/dist/dot-checker',
    "layout-worker": '/bower_components/graphviz-d3-renderer/dist/layout-worker',
    worker: '/bower_components/requirejs-web-workers/src/worker'
  }

Also: Could you list the scripts loaded before the JS code beginning with require(["renderer"]? Or even better, put a working JS/HTML example in the repo?

@mstefaniuk
Copy link
Owner

@mr-niels-christensen I know that usage section is not too elaborated. For quick workaround I suggest to check Graphviz fiddling website or its source on Github.

@mr-niels-christensen
Copy link
Author

Will do. Thanks!

On Fri, Oct 9, 2015 at 11:41 AM Marcin Stefaniuk notifications@github.com
wrote:

@mr-niels-christensen https://github.com/mr-niels-christensen I know
that usage section is not too elaborated. For quick workaround I suggest to
check Graphviz fiddling website http://graphviz.it or its source on
Github http:///mstefaniuk/graphviz.it.


Reply to this email directly or view it on GitHub
#5 (comment)
.

@mstefaniuk
Copy link
Owner

Readme should cover:

  • how to install
  • how to modify animations

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants