a36f95326c50aafd28b8b053669224259c01a803
[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 ## Example
12
13 [View a simple demo ](http://andymatthews.net/code/jquery-mobile-boilerplate/)
14
15 ## Features
16
17 * jQuery Mobile 1.1 Final Compatible!
18 * Project ready. Download (or clone) and go!
19 * The latest jQuery Mobile JS & CSS bits from CDN, with a local option.
20 * The latest jQuery bits from CDN, with a local option.
21 * Override files for both JS and CSS
22 * Extensive UI element snippet library. Easy to copy and paste.
23 * Includes Scott Jehl's fix for the [iOS orientation bug](https://github.com/scottjehl/iOS-Orientationchange-Fix)
24
25 ## Contributing
26
27 You are invited to contribute code and suggestions to this project. The more the merrier.
28
29 ## Project Info
30
31 * Source: http://github.com/commadelimited/jQuery-Mobile-Boilerplate
32 * Twitter: [http://twitter.com/jqmbp](http://twitter.com/jqmbp)
33 * Twitter: [http://twitter.com/commadelimited](http://twitter.com/commadelimited)
34
35 ## License
36
37 ### 3rd party libraries:
38
39 * jQuery: MIT/GPL license
40 * jQuery Mobile: MIT/GPL license
41
42 ### Custom bits:
43
44 Public domain