Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 120 lines (83 sloc) 6.209 kB
a51adb9 updated the readme with more helpful information
scottjehl authored
1 jQuery Mobile Framework
6bc5c65 @eddiemonge Update to include instructions on how to build using a custom theme.
eddiemonge authored
2 =======================
5c86ca6 @eddiemonge 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 @eddiemonge Readme changes
eddiemonge authored
5 [Demos and Documentation](http://jquerymobile.com/test/)
de9d313 @croaky 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 @eddiemonge 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 @croaky 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 @johnbender 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 @eddiemonge 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
9f8018d @johnbender quick addition to readme on how to build with grunt for now, updated …
johnbender authored
18 Alternatively if you have node.js installed you can run
19
20 npm install
21 node node_modules/.bin/grunt <js|css|docs|zip|clean|init>
22
1296abb @eddiemonge Update README.md
eddiemonge authored
23 How to build a self-contained version of the Docs/Demos
24 =======================================================
25 Once you have your own cloned repo on your computer:
26
27 make docs
28
c9eed4e @johnbender whitespace in readme
johnbender authored
29 The docs will be built and available in the compiled/demos folder. You can move this folder to your web server or
1296abb @eddiemonge Update README.md
eddiemonge authored
30 other location. It has no dependencies on anything other than a basic HTML web server.
31
32
9f8018d @johnbender quick addition to readme on how to build with grunt for now, updated …
johnbender authored
33
a51adb9 updated the readme with more helpful information
scottjehl authored
34 Submitting bugs
6bc5c65 @eddiemonge Update to include instructions on how to build using a custom theme.
eddiemonge authored
35 ===============
c9eed4e @johnbender whitespace in readme
johnbender authored
36 If you think you've found a bug, please report it by following these instructions:
5c86ca6 @eddiemonge Readme changes
eddiemonge authored
37
38 1. Visit the [Issue tracker: https://github.com/jquery/jquery-mobile/issues](https://github.com/jquery/jquery-mobile/issues)
39 2. Create an issue explaining the problem and expected result
40 - Be sure to include any relevant information for reproducing the issue
41 - Include information such as:
42 * Browser/device (with version #)
43 * The version of the jQuery Mobile code you're running
44 * If you are running from a git version, include the date and/or hash number
45 - Make sure that the bug still exists at http://jquerymobile.com/test/ as it may be fixed already
46 - You can use the CDN hosted JS and CSS files to test in your own code by using:
47 * [JS](http://code.jquery.com/mobile/latest/jquery.mobile.min.js)
48 * [CSS](http://code.jquery.com/mobile/latest/jquery.mobile.min.css)
49 - Include a link to some code of the bug in action. You can use either of these services to host your code
50 * [jsbin](http://jsbin.com)
51 * [jsfiddle](http://jsfiddle.net)
52 3. Submit the issue.
a51adb9 updated the readme with more helpful information
scottjehl authored
53
f0acc75 @Wilto Fixes #3718 — Updated jsbin template/README reference.
Wilto authored
54 Recommended: [JS Bin issue template with instructions](http://jsbin.com/omacox/edit)
11dbc57 @toddparker Added link to JS Bin template
toddparker authored
55
2b4a29c @jaspermdegroot Update README.md
jaspermdegroot authored
56 Issues concerning the jQuery Mobile Theme Roller can be submitted at the [Theme Roller repo: https://github.com/jquery/web-jquery-mobile-theme-roller](https://github.com/jquery/web-jquery-mobile-theme-roller)
57
a51adb9 updated the readme with more helpful information
scottjehl authored
58 Submitting patches
6bc5c65 @eddiemonge Update to include instructions on how to build using a custom theme.
eddiemonge authored
59 ==================
c9eed4e @johnbender whitespace in readme
johnbender authored
60 To contribute code and bug fixes to jQuery Mobile: fork this project on Github, make changes to the code in your fork,
5c86ca6 @eddiemonge Readme changes
eddiemonge authored
61 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
62
5c86ca6 @eddiemonge Readme changes
eddiemonge authored
63 Detailed instructions can be found at [jQuery Mobile Patching](https://gist.github.com/1294035)
a51adb9 updated the readme with more helpful information
scottjehl authored
64
65 Running the jQuery Mobile demos & docs locally
6bc5c65 @eddiemonge Update to include instructions on how to build using a custom theme.
eddiemonge authored
66 ==============================================
c9eed4e @johnbender whitespace in readme
johnbender authored
67 To preview locally, you'll need to clone a local copy of this repository and point your Apache & PHP webserver at its
5c86ca6 @eddiemonge Readme changes
eddiemonge authored
68 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
69
c9eed4e @johnbender whitespace in readme
johnbender authored
70 If you don't currently have a webserver running locally, there are a few options.
00f86c8 update docs regarding running demos
Matt authored
71
c9eed4e @johnbender whitespace in readme
johnbender authored
72 If you're on a Mac, you can try dropping jQuery Mobile into your sites folder and turning on Web Sharing via System
5c86ca6 @eddiemonge Readme changes
eddiemonge authored
73 Prefs. From there, you'll find a URL where you can browse folders in your sites directory from a browser.
74
c9eed4e @johnbender whitespace in readme
johnbender authored
75 Another quick way to get up and running is to download and install MAMP for Mac OSX. Once installed, just open MAMP,
76 click preferences, go to the Apache tab, and select your local jQuery Mobile folder as the root. Then you can open a
5c86ca6 @eddiemonge Readme changes
eddiemonge authored
77 browser to http://localhost:8888 to preview the code.
78
79 Another alternative is XAMPP (Mac, Windows). You need to actually modify Apache's httpd.conf to point to your checkout:
80 [Instructions](http://www.apachefriends.org/en/xampp.html)
a51adb9 updated the readme with more helpful information
scottjehl authored
81
e97ae76 @eddiemonge Typo fix
eddiemonge authored
82 You need the following Apache modules loaded:
a51adb9 updated the readme with more helpful information
scottjehl authored
83
5c86ca6 @eddiemonge Readme changes
eddiemonge authored
84 * Rewrite (mod\_rewrite.so)
85 * Expire (mod\_expires.so)
86 * Header (mod\_headers.so)
6bc5c65 @eddiemonge Update to include instructions on how to build using a custom theme.
eddiemonge authored
87
e26d7de @johnbender added note about local server support for development
johnbender authored
88 Alternatively, with the addition of async loading, you can use the python simple http server from the project root:
89
90 $ python -m SimpleHTTPServer 8000
91
c97e4d1 @johnbender corrected docs to reflect revert to /js/
johnbender authored
92 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
93
94 <script data-main="js/jquery.mobile.docs" src="external/requirejs/require.js"></script>
95
469d5f7 @forresst Fix typo
forresst authored
96 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 @johnbender added note about local server support for development
johnbender authored
97
98 AMD Support in Development
99 ==========================
100
db42f18 @johnbender note about fouc
johnbender authored
101 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.
102
103 If you find dependency bugs when using the async loading support for development please log them in the github issue tracker.
e26d7de @johnbender added note about local server support for development
johnbender authored
104
6bc5c65 @eddiemonge Update to include instructions on how to build using a custom theme.
eddiemonge authored
105 Building With A Custom Theme
106 ============================
107 To use a custom theme in your own build, you'll need Make installed. You can find the themes in the CSS/Themes folder.
108 To create a new theme:
16ea3fa @eddiemonge Update README.md
eddiemonge authored
109
6bc5c65 @eddiemonge Update to include instructions on how to build using a custom theme.
eddiemonge authored
110 1. Copy the `Default` folder from CSS/Themes to a new folder in the same location. The name of the folder will be the
111 theme's name. For testing locally, make sure the index.php file is copied as well.
112 2. Edit the `jquery.mobile.theme.css` file so it contains your custom fonts and colors.
113 3. Once you are done editing your files and saving them, open a terminal.
114 4. Navigate to the jQuery-Mobile folder's root.
75341c6 @eddiemonge Update the README to include instructions for including a custom theme
eddiemonge authored
115 5. Run the following command to build jQuery-Mobile (THEME is the name of the folder for your theme from step 1.):
6bc5c65 @eddiemonge Update to include instructions on how to build using a custom theme.
eddiemonge authored
116
75341c6 @eddiemonge Update the README to include instructions for including a custom theme
eddiemonge authored
117 make THEME=YourThemeName
c9eed4e @johnbender whitespace in readme
johnbender authored
118
75341c6 @eddiemonge Update the README to include instructions for including a custom theme
eddiemonge authored
119 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.