/README.md

https://github.com/charlieCollins/jquery-mobile · Markdown · 85 lines · 65 code · 20 blank · 0 comment · 0 complexity · 7fa5d965b17ad482c3cceff6b944b6bb MD5 · raw file 

    

  1. jQuery Mobile Framework
    2. 

  2. =======================
    3. 

  3. [Official Site: http://jquerymobile.com](http://jquerymobile.com)
    4. 

  4. 

  5. [Demos and Documentation](http://jquerymobile.com/test/)
    6. 

  6. 

  7. How to build your own jQuery Mobile CSS and JS files
    8. 

  8. ====================================================
    9. 

  9. Clone this repo and build the js and css files (you'll need Git and Make installed):
    10. 

    11. 

  11.     git clone git://github.com/jquery/jquery-mobile.git
    12. 

  12.     cd jquery-mobile
    13. 

  13.     make
    14. 

  14. 

  15. A full version and a minified version of the jQuery Mobile JavaScript and CSS files will be created 
    16. 

  16. in a folder named "compiled". There is also now a Structure only css file so you can add your own theme on top of it.
    17. 

  17. 

  18. Submitting bugs
    19. 

  19. ===============
    20. 

  20. If you think you've found a bug, please report it by following these instructions:  
    21. 

    22. 

  22. 1. Visit the [Issue tracker: https://github.com/jquery/jquery-mobile/issues](https://github.com/jquery/jquery-mobile/issues)
    23. 

  23. 2. Create an issue explaining the problem and expected result
    24. 

  24.     - Be sure to include any relevant information for reproducing the issue
    25. 

  25.     - Include information such as:
    26. 

  26.         * Browser/device (with version #)
    27. 

  27.         * The version of the jQuery Mobile code you're running
    28. 

  28.         * If you are running from a git version, include the date and/or hash number
    29. 

  29.     - Make sure that the bug still exists at http://jquerymobile.com/test/ as it may be fixed already
    30. 

  30.     - You can use the CDN hosted JS and CSS files to test in your own code by using:
    31. 

  31.         * [JS](http://code.jquery.com/mobile/latest/jquery.mobile.min.js)
    32. 

  32.         * [CSS](http://code.jquery.com/mobile/latest/jquery.mobile.min.css)
    33. 

  33.     - Include a link to some code of the bug in action. You can use either of these services to host your code
    34. 

  34.         * [jsbin](http://jsbin.com)
    35. 

  35.         * [jsfiddle](http://jsfiddle.net)
    36. 

  36. 3. Submit the issue.
    37. 

  37. 

  38. Recommended: [JS Bin issue template with instructions](http://jsbin.com/obowiw/edit) 
    39. 

  39. 

  40. Submitting patches
    41. 

  41. ==================
    42. 

  42. To contribute code and bug fixes to jQuery Mobile: fork this project on Github, make changes to the code in your fork, 
    43. 

  43. and then send a "pull request" to notify the team of updates that are ready to be reviewed for inclusion.
    44. 

  44. 

  45. Detailed instructions can be found at [jQuery Mobile Patching](https://gist.github.com/1294035)
    46. 

  46. 

  47. Running the jQuery Mobile demos & docs locally
    48. 

  48. ==============================================
    49. 

  49. To preview locally, you'll need to clone a local copy of this repository and point your Apache & PHP webserver at its 
    50. 

  50. root directory (a webserver is required, as PHP and .htaccess are used for combining development files).
    51. 

  51. 

  52. If you don't currently have a webserver running locally, there are a few options. 
    53. 

    54. 

  54. If you're on a Mac, you can try dropping jQuery Mobile into your sites folder and turning on Web Sharing via System 
    55. 

  55. Prefs. From there, you'll find a URL where you can browse folders in your sites directory from a browser.
    56. 

    57. 

  57. Another quick way to get up and running is to download and install MAMP for Mac OSX. Once installed, just open MAMP, 
    58. 

  58. click preferences, go to the Apache tab, and select your local jQuery Mobile folder as the root. Then you can open a 
    59. 

  59. browser to http://localhost:8888 to preview the code.
    60. 

  60. 

  61. Another alternative is XAMPP (Mac, Windows). You need to actually modify Apache's httpd.conf to point to your checkout:
    62. 

  62. [Instructions](http://www.apachefriends.org/en/xampp.html)
    63. 

  63. 

  64. You need the following Apache modules loaded:
    65. 

  65. 

  66. * Rewrite (mod\_rewrite.so)
    67. 

  67. * Expire (mod\_expires.so)
    68. 

  68. * Header (mod\_headers.so)
    69. 

  69. 

  70. Building With A Custom Theme
    71. 

  71. ============================
    72. 

  72. To use a custom theme in your own build, you'll need Make installed. You can find the themes in the CSS/Themes folder.
    73. 

  73. To create a new theme:
    74. 

  74. 

  75. 1. Copy the `Default` folder from CSS/Themes to a new folder in the same location. The name of the folder will be the
    76. 

  76. theme's name. For testing locally, make sure the index.php file is copied as well.
    77. 

  77. 2. Edit the `jquery.mobile.theme.css` file so it contains your custom fonts and colors.
    78. 

  78. 3. Once you are done editing your files and saving them, open a terminal.
    79. 

  79. 4. Navigate to the jQuery-Mobile folder's root.
    80. 

  80. 5. Run the following command to build jQuery-Mobile. The CSSTHEME specifies what theme to include. If you leave it off,
    81. 

  81. it will build using the "default" theme.
    82. 

  82. 

  83.     make CSSTHEME=YourThemeName
    84. 

  84.     
    85. 

  85. 6. The compiled files will be located in the "compiled" folder in the root of jQuery-Mobile.
    86.