Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 112 lines (79 sloc) 5.862 kb
a51adb9 updated the readme with more helpful information
scottjehl authored
1 jQuery Mobile Framework
6bc5c65 Eddie Monge Update to include instructions on how to build using a custom theme.
eddiemonge authored
2 =======================
5c86ca6 Eddie Monge Readme changes
eddiemonge authored
3 [Official Site: http://jquerymobile.com](http://jquerymobile.com)
af7be5b adding a little readme file - more to add!
scottjehl authored
4
5c86ca6 Eddie Monge Readme changes
eddiemonge authored
5 [Demos and Documentation](http://jquerymobile.com/test/)
de9d313 Dan Croak added instructions for building your own jQuery Mobile
croaky authored
6
a51adb9 updated the readme with more helpful information
scottjehl authored
7 How to build your own jQuery Mobile CSS and JS files
6bc5c65 Eddie Monge Update to include instructions on how to build using a custom theme.
eddiemonge authored
8 ====================================================
a51adb9 updated the readme with more helpful information
scottjehl authored
9 Clone this repo and build the js and css files (you'll need Git and Make installed):
de9d313 Dan Croak added instructions for building your own jQuery Mobile
croaky authored
10
11 git clone git://github.com/jquery/jquery-mobile.git
12 cd jquery-mobile
13 make
14
c9eed4e John Bender whitespace in readme
johnbender authored
15 A full version and a minified version of the jQuery Mobile JavaScript and CSS files will be created
6bc5c65 Eddie Monge Update to include instructions on how to build using a custom theme.
eddiemonge authored
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.
a51adb9 updated the readme with more helpful information
scottjehl authored
17
1296abb Eddie Monge Update README.md
eddiemonge authored
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
c9eed4e John Bender whitespace in readme
johnbender authored
24 The docs will be built and available in the compiled/demos folder. You can move this folder to your web server or
1296abb Eddie Monge Update README.md
eddiemonge authored
25 other location. It has no dependencies on anything other than a basic HTML web server.
26
27
a51adb9 updated the readme with more helpful information
scottjehl authored
28 Submitting bugs
6bc5c65 Eddie Monge Update to include instructions on how to build using a custom theme.
eddiemonge authored
29 ===============
c9eed4e John Bender whitespace in readme
johnbender authored
30 If you think you've found a bug, please report it by following these instructions:
5c86ca6 Eddie Monge Readme changes
eddiemonge authored
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.
a51adb9 updated the readme with more helpful information
scottjehl authored
47
f0acc75 Mat Marquis Fixes #3718 — Updated jsbin template/README reference.
Wilto authored
48 Recommended: [JS Bin issue template with instructions](http://jsbin.com/omacox/edit)
11dbc57 Todd Parker Added link to JS Bin template
toddparker authored
49
a51adb9 updated the readme with more helpful information
scottjehl authored
50 Submitting patches
6bc5c65 Eddie Monge Update to include instructions on how to build using a custom theme.
eddiemonge authored
51 ==================
c9eed4e John Bender whitespace in readme
johnbender authored
52 To contribute code and bug fixes to jQuery Mobile: fork this project on Github, make changes to the code in your fork,
5c86ca6 Eddie Monge Readme changes
eddiemonge authored
53 and then send a "pull request" to notify the team of updates that are ready to be reviewed for inclusion.
a51adb9 updated the readme with more helpful information
scottjehl authored
54
5c86ca6 Eddie Monge Readme changes
eddiemonge authored
55 Detailed instructions can be found at [jQuery Mobile Patching](https://gist.github.com/1294035)
a51adb9 updated the readme with more helpful information
scottjehl authored
56
57 Running the jQuery Mobile demos & docs locally
6bc5c65 Eddie Monge Update to include instructions on how to build using a custom theme.
eddiemonge authored
58 ==============================================
c9eed4e John Bender whitespace in readme
johnbender authored
59 To preview locally, you'll need to clone a local copy of this repository and point your Apache & PHP webserver at its
5c86ca6 Eddie Monge Readme changes
eddiemonge authored
60 root directory (a webserver is required, as PHP and .htaccess are used for combining development files).
a51adb9 updated the readme with more helpful information
scottjehl authored
61
c9eed4e John Bender whitespace in readme
johnbender authored
62 If you don't currently have a webserver running locally, there are a few options.
00f86c8 update docs regarding running demos
Matt authored
63
c9eed4e John Bender whitespace in readme
johnbender authored
64 If you're on a Mac, you can try dropping jQuery Mobile into your sites folder and turning on Web Sharing via System
5c86ca6 Eddie Monge Readme changes
eddiemonge authored
65 Prefs. From there, you'll find a URL where you can browse folders in your sites directory from a browser.
66
c9eed4e John Bender whitespace in readme
johnbender authored
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
5c86ca6 Eddie Monge Readme changes
eddiemonge authored
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)
a51adb9 updated the readme with more helpful information
scottjehl authored
73
e97ae76 Eddie Monge Typo fix
eddiemonge authored
74 You need the following Apache modules loaded:
a51adb9 updated the readme with more helpful information
scottjehl authored
75
5c86ca6 Eddie Monge Readme changes
eddiemonge authored
76 * Rewrite (mod\_rewrite.so)
77 * Expire (mod\_expires.so)
78 * Header (mod\_headers.so)
6bc5c65 Eddie Monge Update to include instructions on how to build using a custom theme.
eddiemonge authored
79
e26d7de John Bender added note about local server support for development
johnbender authored
80 Alternatively, with the addition of async loading, you can use the python simple http server from the project root:
81
82 $ python -m SimpleHTTPServer 8000
83
c97e4d1 John Bender corrected docs to reflect revert to /js/
johnbender authored
84 And in your browser visit [localhost:8000](http://localhost:8000/tests/unit/core/). NOTE: The docs will not load as they are dependent on the "/js/" includes which require php. For other development work such as unit tests and custom test pages using
85
86 <script data-main="js/jquery.mobile.docs" src="external/requirejs/require.js"></script>
87
469d5f7 Stéphane Reynaud Fix typo
forresst authored
88 will allow you to load modules asynchronously without php. Please note that the example above assumes it's inclusion in a page at the root of the directory in which the simple http server was run.
e26d7de John Bender added note about local server support for development
johnbender authored
89
90 AMD Support in Development
91 ==========================
92
db42f18 John Bender note about fouc
johnbender authored
93 Please bear in mind that async loading is not supported for production and is primarily used for the project's build process. As a result developers should expect an initial flash of unstyled content, which will not occur when the library is compiled.
94
95 If you find dependency bugs when using the async loading support for development please log them in the github issue tracker.
e26d7de John Bender added note about local server support for development
johnbender authored
96
6bc5c65 Eddie Monge Update to include instructions on how to build using a custom theme.
eddiemonge authored
97 Building With A Custom Theme
98 ============================
99 To use a custom theme in your own build, you'll need Make installed. You can find the themes in the CSS/Themes folder.
100 To create a new theme:
16ea3fa Eddie Monge Update README.md
eddiemonge authored
101
6bc5c65 Eddie Monge Update to include instructions on how to build using a custom theme.
eddiemonge authored
102 1. Copy the `Default` folder from CSS/Themes to a new folder in the same location. The name of the folder will be the
103 theme's name. For testing locally, make sure the index.php file is copied as well.
104 2. Edit the `jquery.mobile.theme.css` file so it contains your custom fonts and colors.
105 3. Once you are done editing your files and saving them, open a terminal.
106 4. Navigate to the jQuery-Mobile folder's root.
75341c6 Eddie Monge Update the README to include instructions for including a custom theme
eddiemonge authored
107 5. Run the following command to build jQuery-Mobile (THEME is the name of the folder for your theme from step 1.):
6bc5c65 Eddie Monge Update to include instructions on how to build using a custom theme.
eddiemonge authored
108
75341c6 Eddie Monge Update the README to include instructions for including a custom theme
eddiemonge authored
109 make THEME=YourThemeName
c9eed4e John Bender whitespace in readme
johnbender authored
110
75341c6 Eddie Monge Update the README to include instructions for including a custom theme
eddiemonge authored
111 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.