aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorScott González <scott.gonzalez@gmail.com>2012-05-16 09:23:40 -0400
committerScott González <scott.gonzalez@gmail.com>2012-05-16 09:23:55 -0400
commit00086a8ab38ee55deeef78fa787ecfe9314185a5 (patch)
tree74d7f89616ef9d5978127c540a181a92c9d64d9b /README.md
parentf4b2d7a4115814b64ff291e3518fe15f2dfbe390 (diff)
downloadjquery-ui-00086a8ab38ee55deeef78fa787ecfe9314185a5.tar.gz
jquery-ui-00086a8ab38ee55deeef78fa787ecfe9314185a5.zip
Readme: Added notes about running unit tests and creating builds.
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
index edd7797eb..f2845df4c 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,36 @@ pull request for that branch. Don't mix unrelated changes. You can use the commi
message as the description for the pull request.
+Running the Unit Tests
+---
+
+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:
+
+- Windows: [WAMP download](http://www.wampserver.com/en/)
+- Mac: [MAMP download](http://www.mamp.info/en/index.html)
+- Linux: [Setting up LAMP](https://www.linux.com/learn/tutorials/288158-easy-lamp-server-installation)
+- [Mongoose (most platforms)](http://code.google.com/p/mongoose/)
+
+
+Building jQuery UI
+---
+
+jQuery UI uses the [grunt](http://github.com/cowboy/grunt) build system. Building jQuery UI requires node.js and a command line zip program.
+
+Clone the jQuery UI git repo.
+
+`git clone git://github.com/jquery/jquery-ui.git`
+`cd jquery-ui`
+
+Install node modules.
+
+`npm install`
+
+Run grunt.
+
+`grunt build`
+
+
For committers
---
When looking at pull requests, first check for [proper commit messages](http://wiki.jqueryui.com/w/page/12137724/Bug-Fixing-Guide).