Skip to content
This repository
Newer
Older
100644 84 lines (64 sloc) 4.358 kb
a51adb98 » scottjehl
2011-01-31 updated the readme with more helpful information
1 jQuery Mobile Framework
6bc5c659 » eddiemonge
2011-10-18 Update to include instructions on how to build using a custom theme.
2 =======================
5c86ca64 » eddiemonge
2011-10-17 Readme changes
3 [Official Site: http://jquerymobile.com](http://jquerymobile.com)
af7be5bd » scottjehl
2010-09-10 adding a little readme file - more to add!
4
5c86ca64 » eddiemonge
2011-10-17 Readme changes
5 [Demos and Documentation](http://jquerymobile.com/test/)
de9d3138 » croaky
2011-01-25 added instructions for building your own jQuery Mobile
6
a51adb98 » scottjehl
2011-01-31 updated the readme with more helpful information
7 How to build your own jQuery Mobile CSS and JS files
6bc5c659 » eddiemonge
2011-10-18 Update to include instructions on how to build using a custom theme.
8 ====================================================
a51adb98 » scottjehl
2011-01-31 updated the readme with more helpful information
9 Clone this repo and build the js and css files (you'll need Git and Make installed):
de9d3138 » croaky
2011-01-25 added instructions for building your own jQuery Mobile
10
11 git clone git://github.com/jquery/jquery-mobile.git
12 cd jquery-mobile
13 make
14
5c86ca64 » eddiemonge
2011-10-17 Readme changes
15 A full version and a minified version of the jQuery Mobile JavaScript and CSS files will be created
6bc5c659 » eddiemonge
2011-10-18 Update to include instructions on how to build using a custom theme.
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.
a51adb98 » scottjehl
2011-01-31 updated the readme with more helpful information
17
18 Submitting bugs
6bc5c659 » eddiemonge
2011-10-18 Update to include instructions on how to build using a custom theme.
19 ===============
5c86ca64 » eddiemonge
2011-10-17 Readme changes
20 If you think you've found a bug, please report it by following these instructions:
21
22 1. Visit the [Issue tracker: https://github.com/jquery/jquery-mobile/issues](https://github.com/jquery/jquery-mobile/issues)
23 2. Create an issue explaining the problem and expected result
24 - Be sure to include any relevant information for reproducing the issue
25 - Include information such as:
26 * Browser/device (with version #)
27 * The version of the jQuery Mobile code you're running
28 * If you are running from a git version, include the date and/or hash number
29 - Make sure that the bug still exists at http://jquerymobile.com/test/ as it may be fixed already
30 - You can use the CDN hosted JS and CSS files to test in your own code by using:
31 * [JS](http://code.jquery.com/mobile/latest/jquery.mobile.min.js)
32 * [CSS](http://code.jquery.com/mobile/latest/jquery.mobile.min.css)
33 - Include a link to some code of the bug in action. You can use either of these services to host your code
34 * [jsbin](http://jsbin.com)
35 * [jsfiddle](http://jsfiddle.net)
36 3. Submit the issue.
a51adb98 » scottjehl
2011-01-31 updated the readme with more helpful information
37
11dbc577 » toddparker
2011-11-01 Added link to JS Bin template
38 Recommended: [JS Bin issue template with instructions](http://jsbin.com/obowiw/edit)
39
a51adb98 » scottjehl
2011-01-31 updated the readme with more helpful information
40 Submitting patches
6bc5c659 » eddiemonge
2011-10-18 Update to include instructions on how to build using a custom theme.
41 ==================
5c86ca64 » eddiemonge
2011-10-17 Readme changes
42 To contribute code and bug fixes to jQuery Mobile: fork this project on Github, make changes to the code in your fork,
43 and then send a "pull request" to notify the team of updates that are ready to be reviewed for inclusion.
a51adb98 » scottjehl
2011-01-31 updated the readme with more helpful information
44
5c86ca64 » eddiemonge
2011-10-17 Readme changes
45 Detailed instructions can be found at [jQuery Mobile Patching](https://gist.github.com/1294035)
a51adb98 » scottjehl
2011-01-31 updated the readme with more helpful information
46
47 Running the jQuery Mobile demos & docs locally
6bc5c659 » eddiemonge
2011-10-18 Update to include instructions on how to build using a custom theme.
48 ==============================================
5c86ca64 » eddiemonge
2011-10-17 Readme changes
49 To preview locally, you'll need to clone a local copy of this repository and point your Apache & PHP webserver at its
50 root directory (a webserver is required, as PHP and .htaccess are used for combining development files).
a51adb98 » scottjehl
2011-01-31 updated the readme with more helpful information
51
00f86c83 » Matt
2011-07-14 update docs regarding running demos
52 If you don't currently have a webserver running locally, there are a few options.
53
5c86ca64 » eddiemonge
2011-10-17 Readme changes
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 Prefs. From there, you'll find a URL where you can browse folders in your sites directory from a browser.
56
57 Another quick way to get up and running is to download and install MAMP for Mac OSX. Once installed, just open MAMP,
58 click preferences, go to the Apache tab, and select your local jQuery Mobile folder as the root. Then you can open a
59 browser to http://localhost:8888 to preview the code.
60
61 Another alternative is XAMPP (Mac, Windows). You need to actually modify Apache's httpd.conf to point to your checkout:
62 [Instructions](http://www.apachefriends.org/en/xampp.html)
a51adb98 » scottjehl
2011-01-31 updated the readme with more helpful information
63
e97ae76d » eddiemonge
2011-10-17 Typo fix
64 You need the following Apache modules loaded:
a51adb98 » scottjehl
2011-01-31 updated the readme with more helpful information
65
5c86ca64 » eddiemonge
2011-10-17 Readme changes
66 * Rewrite (mod\_rewrite.so)
67 * Expire (mod\_expires.so)
68 * Header (mod\_headers.so)
6bc5c659 » eddiemonge
2011-10-18 Update to include instructions on how to build using a custom theme.
69
70 Building With A Custom Theme
71 ============================
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 To create a new theme:
16ea3fae » eddiemonge
2011-10-18 Update README.md
74
6bc5c659 » eddiemonge
2011-10-18 Update to include instructions on how to build using a custom theme.
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 theme's name. For testing locally, make sure the index.php file is copied as well.
77 2. Edit the `jquery.mobile.theme.css` file so it contains your custom fonts and colors.
78 3. Once you are done editing your files and saving them, open a terminal.
79 4. Navigate to the jQuery-Mobile folder's root.
75341c6c » eddiemonge
2011-11-09 Update the README to include instructions for including a custom theme
80 5. Run the following command to build jQuery-Mobile (THEME is the name of the folder for your theme from step 1.):
6bc5c659 » eddiemonge
2011-10-18 Update to include instructions on how to build using a custom theme.
81
75341c6c » eddiemonge
2011-11-09 Update the README to include instructions for including a custom theme
82 make THEME=YourThemeName
6bc5c659 » eddiemonge
2011-10-18 Update to include instructions on how to build using a custom theme.
83
75341c6c » eddiemonge
2011-11-09 Update the README to include instructions for including a custom theme
84 6. The compiled files will be located in the "compiled" folder in the root of jQuery-Mobile.
Something went wrong with that request. Please try again.