github.com/cayleygraph/cayley@v0.7.7/static/third_party/sigmajs/README.md (about)

     1  [![Build Status](https://travis-ci.org/jacomyal/sigma.js.png)](https://travis-ci.org/jacomyal/sigma.js)
     2  
     3  sigma.js - v1.0.2
     4  =================
     5  
     6  Sigma is a JavaScript library dedicated to graph drawing.
     7  
     8  ### Resources
     9  
    10  [The website](http://sigmajs.org) provides a global overview of the project, and the documentation is available in the [Github Wiki](https://github.com/jacomyal/sigma.js/wiki).
    11  
    12  Also, the `plugins` and `examples` directories contain some various use-cases, that might help you understanding how to use sigma.
    13  
    14  ### How to use it
    15  
    16  To use it, clone the repository:
    17  
    18  ```
    19  git clone git@github.com:jacomyal/sigma.js.git
    20  ```
    21  
    22  To build the code:
    23  
    24   - Install [Node.js](http://nodejs.org/).
    25   - Install [gjslint](https://developers.google.com/closure/utilities/docs/linter_howto?hl=en).
    26   - Use `npm install` to install sigma development dependencies.
    27   - Use `npm run build` to minify the code with [Uglify](https://github.com/mishoo/UglifyJS). The minified file `sigma.min.js` will then be accessible in the `build/` folder.
    28  
    29  Also, you can customize the build by adding or removing files from the `coreJsFiles` array in `Gruntfile.js` before applying the grunt task.
    30  
    31  ### Contributing
    32  
    33  You can contribute by submitting [issues tickets](http://github.com/jacomyal/sigma.js/issues) and proposing [pull requests](http://github.com/jacomyal/sigma.js/pulls). Make sure that tests and linting pass before submitting any pull request by running the command `grunt`.
    34  
    35  The whole source code is validated by the [Google Closure Linter](https://developers.google.com/closure/utilities/) and [JSHint](http://www.jshint.com/), and the comments are written in [JSDoc](http://en.wikipedia.org/wiki/JSDoc) (tags description is available [here](https://developers.google.com/closure/compiler/docs/js-for-compiler)).