Permalink
Browse files

Readme changes

  • Loading branch information...
1 parent 575f4f3 commit 5c86ca648013d1ec75333a92ec8be42c8277230c @eddiemonge eddiemonge committed Oct 17, 2011
Showing with 39 additions and 25 deletions.
  1. +39 −25 README.md
View
@@ -1,52 +1,66 @@
jQuery Mobile Framework
=====
-http://jquerymobile.com
-
-
-Demos and documentation
-===================================
-http://jquerymobile.com/test/
+[Official Site: http://jquerymobile.com](http://jquerymobile.com)
+[Demos and Documentation](http://jquerymobile.com/test/)
How to build your own jQuery Mobile CSS and JS files
===================================
-
Clone this repo and build the js and css files (you'll need Git and Make installed):
git clone git://github.com/jquery/jquery-mobile.git
cd jquery-mobile
make
-A full, complete version and a minified, complete version of the jQuery Mobile JavaScript and CSS files will be created in a folder named "compiled".
-
+A full version and a minified version of the jQuery Mobile JavaScript and CSS files will be created
+in a folder named "compiled".
Submitting bugs
===================================
-
-If you think you've found a bug, please visit the Issue tracker (https://github.com/jquery/jquery-mobile/issues) and create an issue explaining the problem and expected result. Be sure to include any relevant information for reproducing the issue, such as the browser/device (with version #), and the version of the jQuery Mobile code you're running. It also helps a lot to make sure that the bug still exists on http://jquerymobile.com/test/, as it's possible we may have fixed it already!
-
-It is also best to include code to reproduce the bug. To do that please use [jsbin](http://jsbin.com) or [jsfiddle](http://jsfiddle.net) and include a link to it in the ticket.
-
+If you think you've found a bug, please report it by following these instructions:
+
+1. Visit the [Issue tracker: https://github.com/jquery/jquery-mobile/issues](https://github.com/jquery/jquery-mobile/issues)
+2. Create an issue explaining the problem and expected result
+ - Be sure to include any relevant information for reproducing the issue
+ - Include information such as:
+ * Browser/device (with version #)
+ * The version of the jQuery Mobile code you're running
+ * If you are running from a git version, include the date and/or hash number
+ - Make sure that the bug still exists at http://jquerymobile.com/test/ as it may be fixed already
+ - You can use the CDN hosted JS and CSS files to test in your own code by using:
+ * [JS](http://code.jquery.com/mobile/latest/jquery.mobile.min.js)
+ * [CSS](http://code.jquery.com/mobile/latest/jquery.mobile.min.css)
+ - Include a link to some code of the bug in action. You can use either of these services to host your code
+ * [jsbin](http://jsbin.com)
+ * [jsfiddle](http://jsfiddle.net)
+3. Submit the issue.
Submitting patches
===================================
+To contribute code and bug fixes to jQuery Mobile: fork this project on Github, make changes to the code in your fork,
+and then send a "pull request" to notify the team of updates that are ready to be reviewed for inclusion.
-To contribute code and bug fixes to jQuery Mobile: fork this project on Github, make changes to the code in your fork, and then send a
-"pull request" to notify the team of updates that are ready to be reviewed for inclusion.
-
-Detailed instructions can be found at https://gist.github.com/726275
-
+Detailed instructions can be found at [jQuery Mobile Patching](https://gist.github.com/1294035)
Running the jQuery Mobile demos & docs locally
===================================
-
-To preview locally, you'll need to clone a local copy of this repository and point your Apache & PHP webserver at its root directory (a webserver is required, as PHP and .htaccess are used for combining development files).
+To preview locally, you'll need to clone a local copy of this repository and point your Apache & PHP webserver at its
+root directory (a webserver is required, as PHP and .htaccess are used for combining development files).
If you don't currently have a webserver running locally, there are a few options.
-If you're on a Mac, you can try dropping jQuery Mobile into your sites folder and turning on Web Sharing via System Prefs. From there, you'll find a URL where you can browse folders in your sites directory from a browser.
+If you're on a Mac, you can try dropping jQuery Mobile into your sites folder and turning on Web Sharing via System
+Prefs. From there, you'll find a URL where you can browse folders in your sites directory from a browser.
+
+Another quick way to get up and running is to download and install MAMP for Mac OSX. Once installed, just open MAMP,
+click preferences, go to the Apache tab, and select your local jQuery Mobile folder as the root. Then you can open a
+browser to http://localhost:8888 to preview the code.
+
+Another alternative is XAMPP (Mac, Windows). You need to actually modify Apache's httpd.conf to point to your checkout:
+[Instructions](http://www.apachefriends.org/en/xampp.html)
-Another quick way to get up and running is to download and install MAMP for Mac OSX. Once installed, just open MAMP, click preferences, go to the Apache tab, and select your local jQuery Mobile folder as the root. Then you can open a browser to http://localhost:8888 to preview the code.
+You need the following Apache module loaded:
-Another alternative is XAMPP, which is also available for Windows, though you need to actually modify Apache's httpd.conf to point to your checkout: http://www.apachefriends.org/en/xampp.html
-You need the Rewrite (mod_rewrite.so), Expire (mod_expires.so) and Header (mod_headers.so) modules loaded.
+* Rewrite (mod\_rewrite.so)
+* Expire (mod\_expires.so)
+* Header (mod\_headers.so)

0 comments on commit 5c86ca6

Please sign in to comment.