ResourcesThe website provides a global overview of the project, and the documentation is available in the Github Wiki.
examplesdirectories contain various use-cases that might help you understand how to use sigma.
How to use itTo use it, clone the repository:
git clone firstname.lastname@example.org:jacomyal/sigma.js.git
To build the code:
- Install Node.js. - Install gjslint. - Use
npm installto install sigma development dependencies. - Use
npm run buildto minify the code with Uglify. The minified file
sigma.min.jswill then be accessible in the
Also, you can customize the build by adding or removing files from the
Gruntfile.jsbefore applying the grunt task.
ContributingYou can contribute by submitting issues tickets and proposing pull requests. Make sure that tests and linting pass before submitting any pull request by running the command
The whole source code is validated by the Google Closure Linter and JSHint, and the comments are written in JSDoc (tags description is available here).