From e4fd77b39e441cf7f671f6ca6d81c1401256c4f1 Mon Sep 17 00:00:00 2001 From: Dan Vanderkam Date: Sat, 24 Oct 2015 22:33:10 -0400 Subject: [PATCH] Update docs --- DEVELOP.md | 18 ++++++++++++------ README.md | 14 +++----------- bower.json | 5 ++--- package.json | 2 +- 4 files changed, 18 insertions(+), 21 deletions(-) diff --git a/DEVELOP.md b/DEVELOP.md index 8ddf024..7436326 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -8,19 +8,25 @@ This is a step-by-step guide explaining how to do it. To build dygraphs, run - gulp dist + npm run build To run the tests, run: - gulp test + npm run build-tests + npm run test -To iterate on the code, open `tests/demo.html` (or one of the other demos) in your browser. +To iterate on the code, run: -To iterate on a unit test, change `it` to `it.only` in the Mocha test. Then run + npm run watch - ./node_modules/karma/bin/karma start auto_tests/chrome.karma.conf.js +and open `tests/demo.html` (or one of the other demos) in your browser. -and hit "DEBUG" in the Karma UI. +To iterate on a unit test, run the `watch` command above and open + + auto_tests/runner.html + +in your browser. You can use the Mocha UI to run just a single test or suite. +Or you can change `it` to `it.only` to do run just one test in code. ### dygraphs style diff --git a/README.md b/README.md index 7e3b0f2..9abb9a1 100644 --- a/README.md +++ b/README.md @@ -51,19 +51,11 @@ seeing demonstrations of what dygraphs can do in the To get going, clone the repo and run: npm install - gulp dist + npm run build + +Then open `tests/demo.html` in your browser. Read more about the dygraphs development process in the [developer guide](/DEVELOP.md). ## License(s) -dygraphs uses: - - UglifyJS (BSD License) - - JsDoc Toolkit (MIT license) - - console-polyfill (MIT license) - -automated tests use: - - auto_tests/lib/jquery-1.4.2.js (MIT & GPL2) - - auto_tests/lib/Asserts.js (Apache 2.0 License) - - auto-tests/lib/JsTestDriver-1.3.3cjar (Apache 2.0 License) - dygraphs is available under the MIT license, included in LICENSE.txt. diff --git a/bower.json b/bower.json index c7bffe2..6ebcc5c 100644 --- a/bower.json +++ b/bower.json @@ -1,13 +1,11 @@ { "name": "dygraphs", - "main": "dygraph-combined.js", + "main": "dist/dygraph.js", "ignore": [ "Makefile", "NOTES", "auto_tests", - "closure-todo.txt", "common", - "compile-with-closure.sh", "data.js", "docs", "experimental", @@ -31,6 +29,7 @@ "release.sh", "releases.json", "screenshot.png", + "scripts", "test.sh", "tests", "thumbnail.png" diff --git a/package.json b/package.json index 9250bb7..48b6534 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "dygraphs", "version": "1.1.0", "description": "dygraphs is a fast, flexible open source JavaScript charting library.", - "main": "dygraph-combined-dev.js", + "main": "dist/src/dygraph.js", "directories": { "doc": "docs", "test": "tests" -- 2.7.4