nvd3/README.md

54 lines
2.0 KiB
Markdown
Raw Normal View History

2012-11-19 22:06:49 +00:00
Please see Novus' official statement on nvd3 with an explanation,
apology, and commitment to its permanent status as an open-source
2012-11-20 14:17:17 +00:00
project.
2012-11-20 00:15:07 +00:00
[http://nvd3.org/statement.html](http://nvd3.org/statement.html)
2012-11-19 22:06:49 +00:00
2012-03-25 02:39:55 +00:00
# nvd3 - v0.0.1
2012-11-20 14:17:17 +00:00
A reusable chart library for d3.JS.
2012-03-25 02:39:55 +00:00
Currently in an early stage of development, but will be a very active project. It may change quite a bit from its current state, but will always try to follow the style in which d3.js was done.
2012-11-20 02:14:25 +00:00
You can also check out the [examples page](http://nvd3.org/ghpages/examples.html)
2012-05-02 00:53:44 +00:00
---
2013-04-06 14:48:49 +00:00
# Current Improvement focus
Upgrade to d3.v3 in progress!
---
If one of [the existing models](https://github.com/novus/nvd3/tree/master/src/models) doesn't meet your needs, fork the project, implement the model and an example using it, send us a pull request, for consideration for inclusion in the project.
2013-04-06 14:39:30 +00:00
Please do not aggregate pull requests. Aggregated pull requests are actually more difficult to review!
We are currently changing our branch structure so that master will be gauranteed stable. In addition, there is now a "development" branch. This branch reflects the latest changes to nvd3 and is not necessarily stable.
---
Minifying your fork:
2012-09-29 22:11:59 +00:00
The Makefile requires [UglifyJS](https://github.com/mishoo/UglifyJS).
2013-01-27 01:38:10 +00:00
The easiest way to install is to install via npm. Run `npm install
uglify-js` from your home directory, then add the output from `npm bin`
into your path so that you have access to `uglifyjs` from the command
line (remember to restart your terminal window when adding to the path.)
2012-09-30 00:16:58 +00:00
Once you have `uglifyjs` command available, running `make` from your
fork's root directory will rebuild both `nv.d3.js` and `nv.d3.min.js`.
2012-09-27 05:59:17 +00:00
Without UglifyJS, you won't get the minified version when running make.
**We ask that you DO NOT minify pull requests...
If you need to minify please build pull request in separate branch, and
2013-03-29 01:38:19 +00:00
merge and minify in your master.
2012-09-27 05:59:17 +00:00
2013-02-01 18:00:42 +00:00
## (Officially) Supported Browsers
2013-02-01 18:01:23 +00:00
* Chrome latest version (preferred)
* Firefox latest version
* Safari latest version
2013-02-01 18:00:42 +00:00
* Internet Explorer 9 and 10