sigma-fork-darthtrevino
v1.2.5
Published
A JavaScript library dedicated to graph drawing.
Downloads
5
Readme
sigma.js - v1.2.1
Sigma is a JavaScript library dedicated to graph drawing, mainly developed by @jacomyal and @Yomguithereal.
Resources
The website provides a global overview of the project, and the documentation is available in the GitHub Wiki.
The examples
directory contains various use-cases that might help you understand how to use sigma.
How to use it
To use it, clone the repository:
git clone [email protected]:jacomyal/sigma.js.git
To build the code:
- Install Node.js.
- Use
npm install
to install sigma development dependencies. - Use
npm run build:dev
to bundle the code with Rollup. The resultant libraries will then be accessible in thebuild/
folder. - use
npm run build:prod
to bundle the minified production code.
Contributing
You 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 npm test
script.
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).