998a3f24be148af7133002490c1b700e873fe8ac
[yaffs-website] / web / core / assets / vendor / jquery.ui / README.md
1 # [jQuery UI](http://jqueryui.com/) - Interactions and Widgets for the web
2
3 jQuery UI is a curated set of user interface interactions, effects, widgets, and themes built on top of jQuery. Whether you're building highly interactive web applications, or you just need to add a date picker to a form control, jQuery UI is the perfect choice.
4
5 If you want to use jQuery UI, go to [jqueryui.com](http://jqueryui.com) to get started, [jqueryui.com/demos/](http://jqueryui.com/demos/) for demos, [api.jqueryui.com](http://api.jqueryui.com/) for API documentation, or the [Using jQuery UI Forum](http://forum.jquery.com/using-jquery-ui) for discussions and questions.
6
7 If you want to report a bug/issue, please visit [bugs.jqueryui.com](http://bugs.jqueryui.com).
8
9 If you are interested in helping develop jQuery UI, you are in the right place.
10 To discuss development with team members and the community, visit the [Developing jQuery UI Forum](http://forum.jquery.com/developing-jquery-ui) or [#jqueryui-dev on irc.freenode.net](http://irc.jquery.org/).
11
12
13 ## For Contributors
14
15 If you want to help and provide a patch for a bugfix or new feature, please take
16 a few minutes and look at [our Getting Involved guide](http://wiki.jqueryui.com/w/page/35263114/Getting-Involved).
17 In particular check out the [Coding standards](http://wiki.jqueryui.com/w/page/12137737/Coding-standards)
18 and [Commit Message Style Guide](http://contribute.jquery.org/commits-and-pull-requests/#commit-guidelines).
19
20 In general, fork the project, create a branch for a specific change and send a
21 pull request for that branch. Don't mix unrelated changes. You can use the commit
22 message as the description for the pull request.
23
24 For more information, see the [contributing page](CONTRIBUTING.md).
25
26 ## Running the Unit Tests
27
28 Run the unit tests manually with appropriate browsers and any local web server. See our [environment setup](CONTRIBUTING.md#environment-minimum-required) and [information on running tests](CONTRIBUTING.md#running-the-tests).
29
30 You can also run the unit tests inside phantomjs by [setting up your environment](CONTRIBUTING.md#user-content-environment-recommended-setup).
31
32 ## Building jQuery UI
33
34 jQuery UI uses the [Grunt](http://gruntjs.com/) build system.
35
36 To build jQuery UI, [setup your environment]([setting up your environment](CONTRIBUTING.md#environment-minimum-required)) and then run the following commands:
37
38 ```sh
39 # Run the concat task to concatenate files
40 grunt concat
41
42 # There are many other tasks that can be run through Grunt.
43 # For a list of all tasks:
44 grunt --help
45 ```