Repository files navigation

Sigma is a JavaScript library dedicated to graph drawing, mainly developed by@jacomyal and@Yomguithereal.

The website provides a global overview of the project, and the documentation is available in theGithub Wiki.

Also, theplugins andexamples directories contain various use-cases that might help you understand how to use sigma.

To use it, clone the repository:

git clone git@github.com:jacomyal/sigma.js.git

To build the code:

• InstallNode.js.
• Installgjslint.
• Usenpm install to install sigma development dependencies.
• Usenpm run build to minify the code withUglify. The minified filesigma.min.js will then be accessible in thebuild/ folder.

Also, you can customize the build by adding or removing files from thecoreJsFiles array inGruntfile.js before applying the grunt task.

You can contribute by submittingissues tickets and proposingpull requests. Make sure that tests and linting pass before submitting any pull request by running the commandgrunt.

The whole source code is validated by theGoogle Closure Linter andJSHint, and the comments are written inJSDoc (tags description is availablehere).