Skip to content

Commit 865509d

Browse files
committed
Update docs to reflect new test suite
1 parent 27b4e03 commit 865509d

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,24 +241,30 @@ I'm sure there are heaps more. [Let me know if you'd like me to feature your sit
241241
How to Build
242242
------------
243243

244-
Stellar.js uses [Grunt](http://gruntjs.com).
244+
Stellar.js uses [Grunt](http://gruntjs.com) and [PhantomJS](http://phantomjs.org/).
245245

246-
Once you've got Grunt set up, you can validate, concatenate and minify the project with the following command:
246+
Once you've got Grunt and PhantomJS set up, you can validate, test, concatenate and minify the project with the following command:
247247

248248
`grunt`
249249

250+
Each of the build steps are also available individually.
251+
252+
To test the code using QUnit and PhantomJS:
253+
254+
`grunt qunit`
255+
250256
To validate the code using JSHint:
251257

252258
`grunt lint`
253259

254-
To continuously validate the code while developing:
260+
To continuously validate and test the code while developing:
255261

256262
`grunt watch`
257263

258264
Contributing to Stellar.js
259265
--------------------------
260266

261-
Make sure that all plugin changes are made in `src/jquery.stellar.js` (`jquery.stellar.js` and `jquery.stellar.min.js` are generated by Grunt), and that you build the project with `grunt` before committing.
267+
Make sure that all plugin changes are made in `src/jquery.stellar.js` (`/jquery.stellar.js` and `/jquery.stellar.min.js` are generated by Grunt), and that you successfully test and build the project with `grunt` before committing.
262268

263269
If you want to contribute in a way that changes the API, please file an issue before submitting a pull request so we can discuss how to appropriately integrate your ideas.
264270

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy