6f9753430489b9abf4dcf2e9d191d82ffa9d56f4
[ReadingsJQM.git] / readme.md
1 # Welcome to jQuery Mobile Boilerplate
2
3 "What do I need in a new jQuery Mobile project?". This project is meant to be a single place for developers to get started using jQuery Mobile. It includes icon files, robots.txt (and human).txt files, as well as an extensive snippets library that developers can use as reference.
4
5 **Note:** The jQuery team has offered two options for CSS file inclusion. If you're planning on using a custom theme then you only need to include `jquery.mobile.structure-1.1.0.min.css`.
6
7 ## Quick start
8
9 Clone the git repo - `git clone git@github.com:commadelimited/jQuery-Mobile-Boilerplate.git` - or [download it](https://github.com/commadelimited/jQuery-Mobile-Boilerplate/zipball/master)
10
11 **Note:** By default, the links to the CSS and JS files are root relative.
12 `<script src="/js/application.js"></script>`
13
14 Boilerplate expects to be placed in the root of your website. If this is not the configuration you're using then you'll need to update these links manually.
15 `<script src="js/application.js"></script>`
16
17 ## Example
18
19 [View a simple demo ](http://andymatthews.net/code/jquery-mobile-boilerplate/)
20
21 ## Features
22
23 * jQuery Mobile 1.1 Final Compatible!
24 * Project ready. Download (or clone) and go!
25 * The latest jQuery Mobile JS & CSS bits from CDN, with a local option.
26 * The latest jQuery bits from CDN, with a local option.
27 * Override files for both JS and CSS
28 * Extensive UI element snippet library. Easy to copy and paste.
29 * Includes Scott Jehl's fix for the [iOS orientation bug](https://github.com/scottjehl/iOS-Orientationchange-Fix)
30
31 ## Contributing
32
33 You are invited to contribute code and suggestions to this project. The more the merrier.
34
35 ## Project Info
36
37 * Source: http://github.com/commadelimited/jQuery-Mobile-Boilerplate
38 * Twitter: [http://twitter.com/jqmbp](http://twitter.com/jqmbp)
39 * Twitter: [http://twitter.com/commadelimited](http://twitter.com/commadelimited)
40
41 ## License
42
43 ### 3rd party libraries:
44
45 * jQuery: MIT/GPL license
46 * jQuery Mobile: MIT/GPL license
47
48 ### Custom bits:
49
50 Public domain