Please don't edit files in the dist
subdirectory as they are generated via Grunt. You'll find source code in the src
subdirectory!
Regarding code style like indentation and whitespace, follow the conventions you see used in the source already (tabs).
While Grunt can run the included unit tests via PhantomJS, this shouldn't be considered a substitute for the real thing. Please be sure to test the test/*.html
unit test file(s) in actual browsers.
First, ensure that you have the latest Node.js and npm installed.
Test that Grunt's CLI is installed by running grunt --version
. If the command isn't found, run npm install -g grunt-cli
. For more information about installing Grunt, see the getting started guide.
npm install
to install all dependencies (including Grunt).grunt
to grunt this project.Assuming that you don't see any red, you're ready to go. Just be sure to run grunt
after making any changes, to ensure that nothing is broken.
master
branch directly. Please pull from the dev
branch.grunt
to see the tests fail.grunt
to see if the tests pass. Repeat steps 2-4 until done.test/*.html
unit test file(s) in actual browser to ensure tests pass everywhere.dev
branch).