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