Skip to content

Commit c49b210

Browse files
committed
Docs: Clarify PHP Usage
Clarify that PHP is not required for testing and add a link to the CONTRIBUTING page.
1 parent faefab8 commit c49b210

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,12 @@ Every week (unless otherwise noted) the jQuery UI team has a meeting to discuss
2222

2323
jQuery UI uses Node.js & Grunt to automate the building and validation of source code.
2424

25-
Some tests depend on PHP running locally, so make sure you have the following installed:
25+
The tests require a local web server and the samples contain some PHP, so a PHP web server may be useful.
2626

27-
* A web server with PHP support (any will do, such as [XAMPP](http://www.apachefriends.org/en/xampp.html) or [MAMP](http://www.mamp.info/en/index.html))
28-
* [Node.js](http://nodejs.org/) (includes NPM, necessary for the next step)
29-
* Grunt (install with: `npm install -g grunt`)
27+
* Get [Node.js](http://nodejs.org/) (includes NPM, necessary for the next step)
28+
* Install Grunt cli (install with: `npm install -g grunt`)
29+
* Install local modules (`npm install` in the root directory)
30+
* Install a web server (PHP support optional - such as [XAMPP](http://www.apachefriends.org/en/xampp.html) or [MAMP](http://www.mamp.info/en/index.html) or for node you can use [http-server](https://www.npmjs.com/package/http-server))
3031

3132
### Build a Local Copy of jQuery UI
3233

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,21 @@ In general, fork the project, create a branch for a specific change and send a
2121
pull request for that branch. Don't mix unrelated changes. You can use the commit
2222
message as the description for the pull request.
2323

24+
For more detailed information, see the [contributing page](CONTRIBUTING.md).
2425

2526
## Running the Unit Tests
2627

27-
Run the unit tests with a local server that supports PHP. No database is required. Pre-configured php local servers are available for Windows and Mac. Here are some options:
28+
You can run the unit tests inside phantomjs by [installing node](http://nodejs.org/) and the required modules(`npm install`) and then running `grunt test`.
29+
30+
Run the unit tests manually with any local web server (e.g. [http-server](https://www.npmjs.com/package/http-server)).
31+
32+
Some samples require PHP (but no database is required). Pre-configured php local servers are available for Windows and Mac. Here are some options:
2833

2934
- Windows: [WAMP download](http://www.wampserver.com/en/)
3035
- Mac: [MAMP download](http://www.mamp.info/en/index.html)
3136
- Linux: [Setting up LAMP](https://www.linux.com/learn/tutorials/288158-easy-lamp-server-installation)
3237
- [Mongoose (most platforms)](http://code.google.com/p/mongoose/)
3338

34-
3539
## Building jQuery UI
3640

3741
jQuery UI uses the [Grunt](http://github.com/gruntjs/grunt) build system.

0 commit comments

Comments
 (0)