aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 7 insertions, 10 deletions
diff --git a/README.md b/README.md
index d02a93936..9731e95d3 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,16 @@
-[jQuery UI](http://jqueryui.com/) - Interactions and Widgets for the web
-================================
+# [jQuery UI](http://jqueryui.com/) - Interactions and Widgets for the web
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.
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.
+If you want to report a bug/issue, please visit [bugs.jqueryui.com](http://bugs.jqueryui.com).
+
If you are interested in helping develop jQuery UI, you are in the right place.
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/).
-For contributors
----
+## For contributors
If you want to help and provide a patch for a bugfix or new feature, please take
a few minutes and look at [our Getting Involved guide](http://wiki.jqueryui.com/w/page/35263114/Getting-Involved).
@@ -22,8 +22,7 @@ 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
----
+## 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:
@@ -33,8 +32,7 @@ Run the unit tests with a local server that supports PHP. No database is require
- [Mongoose (most platforms)](http://code.google.com/p/mongoose/)
-Building jQuery UI
----
+## Building jQuery UI
jQuery UI uses the [Grunt](http://github.com/gruntjs/grunt) build system.
@@ -61,8 +59,7 @@ grunt --help
```
-For committers
----
+## For committers
When looking at pull requests, first check for [proper commit messages](http://wiki.jqueryui.com/w/page/12137724/Bug-Fixing-Guide).